GitBook هو نظام أساسي يتيح لك وللفريق الخاص بك إنشاء مواقع التوثيق والتعاون فيها. يقوم GitBook بهذا باستخدام مفاهيم التحكم في الإصدار ، مثل التفريع والدمج.
نظرًا لأن العديد من أعضاء الفريق يمكنهم العمل في موقع توثيق واحد ، فإن GitBook يسمح لك بإنشاء وإدارة مسودات منفصلة. يمكنك أيضًا عرض الاختلافات بين المسودة الحالية ونسخة التوثيق الرئيسية.
تتوفر عدة أنواع من الكتل لإضافتها إلى صفحات wiki الخاصة بك. يتضمن ذلك العناوين والفقرات والصور والتلميحات والجداول وكتل التعليمات البرمجية ومرفقات الملفات والمزيد.
كيفية إضافة كتل المحتوى في GitBook
يمكنك عرض قائمة بكتل المحتوى المتاحة لإضافتها إلى الصفحة. يمكنك القيام بذلك عن طريق النقر فوق أي مكان في الصفحة والنقر فوق ملف زائد الرمز الذي يظهر. يمكنك أيضًا البحث مباشرة عن كتلة محتوى معينة.
يمكنك إضافة محتوى باستخدام Markdown. إذا لم تكن قد استخدمت Markdown من قبل ، فيمكنك معرفة المزيد عنه كيف تبدأ مع Markdown. يمكنك أيضا قراءة المزيد عن لماذا Markdown يحظى بشعبية كبيرة.
كيفية إضافة فقرات أو قوائم أو اقتباسات أو كتل تعليمات برمجية
لإضافة قوائم أو فقرات أو علامات اقتباس أو كتل تعليمات برمجية أو كتل محتوى بسيطة أخرى ، افتح القائمة المنسدلة وحدد من الأنواع المتاحة.
- في إحدى صفحات موقع التوثيق الخاص بك ، انقر فوق زائد زر في الموقع حيث تريد إضافة المحتوى الخاص بك.
- من القائمة المنسدلة ، يمكنك التمرير عبر القائمة لعرض خيارات المحتوى المختلفة.
- من هنا ، حدد أي نوع محتوى بسيط ، مثل فقرة أو مقطع تعليمات برمجية أو عنوان أو اقتباس. سيقوم GitBook تلقائيًا بتغيير المحتوى لمطابقة التنسيق الذي حددته.
كيفية إضافة الصور أو الملفات المرفقة
لإضافة صور ، استخدم القائمة المنسدلة لتحديد ملف الصور خيار حظر المحتوى. لإضافة ملفات ، حدد ملف أدخل الملفات الخيار بدلا من ذلك. يمكنك بعد ذلك استخدام اللوحة اليمنى لإدارة الصور والملفات التي تم تحميلها.
- افتح صفحة على موقع التوثيق الخاص بك. اضغط على زائد زر لفتح القائمة المنسدلة لكتل المحتوى المتاحة.
- يختار أدخل الصور.
- في اللوحة اليمنى التي تظهر ، هناك ثلاث علامات تبويب. ال الملفات علامة التبويب تسمح لك بتحميل ملف الصورة الخاص بك. ال URL علامة التبويب تتيح لك الارتباط بصورة عبر الإنترنت. يمكنك أيضًا فتح ملف Unsplash التبويب. هذا هو المكان الذي يمكنك فيه تحديد الصور الحالية التي لا تتطلب الإسناد.
- بمجرد إضافة صورة ، انقر فوق ثلاث نقاط الموجود في الزاوية العلوية اليسرى من الصورة. سيؤدي هذا إلى فتح قائمة منسدلة حيث يمكنك محاذاة الصورة أو حذفها. يمكنك أيضًا إعطاء الصورة تعليقًا.
- لإدراج الملفات ، ضع المؤشر في أي مكان على صفحة في موقع التوثيق الخاص بك. اضغط على زائد زر لفتح القائمة المنسدلة لأنواع كتلة المحتوى. هذه المرة ، انقر فوق أدخل الملفات اختيار.
- ستظهر لوحة يمين مشابهة ، مما يسمح لك بتحميل أي ملف مرفق بدلاً من صورة. انقر فوق تصفح ملفات لتحديد ملف مخزن محليًا على جهاز الكمبيوتر الخاص بك.
- سيظهر الملف في القائمة. انقر فوق الملف ، وسيقوم GitBook بإنشاء كتلة محتوى مع مرفق الملف على الصفحة التي قمت بفتحها. سيؤدي النقر فوق كتلة المحتوى هذه إلى تنزيل الملف المرفق.
كيفية إضافة التلميحات
يمكنك أيضًا إضافة تلميحات إلى صفحتك. يمكنك تغيير رمز التلميحات لاستخدام اللون الأحمر في حالة الخطر ، أو البرتقالي للتحذير ، أو الأزرق للحصول على المعلومات ، أو الأخضر للنجاح.
- لإضافة تلميح ، انقر فوق زائد زر لفتح القائمة المنسدلة لكتل المحتوى المتاحة.
- يختار ملحوظة.
- سيضيف هذا تلميحًا إلى صفحتك. بشكل افتراضي ، نوع التلميح هو "معلومات" ، ويحتوي على أيقونة زرقاء.
- يمكنك تغيير نوع التلميح بالضغط على الأيقونة. سيؤدي هذا إلى تكرار أنواع التلميح الأربعة المختلفة.
كيفية إضافة الجداول
يمكنك إضافة الجداول عن طريق اختيار الطاولة الخيار من القائمة المنسدلة. بمجرد أن يكون لديك الجدول على الصفحة ، يمكنك إضافة صفوف أو أعمدة جديدة. يمكنك أيضًا تعديل أسماء وأنواع بيانات الأعمدة ، وتغيير البيانات داخل الجدول.
- اضغط على زائد زر لفتح القائمة المنسدلة لكتل المحتوى المتاحة.
- يختار الطاولة.
- انقر فوق رأس العمود في الجدول. سيؤدي هذا إلى فتح قائمة جديدة أصغر حجمًا ، حيث يمكنك تغيير اسم العمود المحدد. تتيح لك هذه القائمة أيضًا حذف العمود المحدد أو إخفائه. بالنسبة لأنواع بيانات أعمدة معينة ، يمكنك أيضًا محاذاة المحتوى داخل العمود.
- بشكل افتراضي ، نوع البيانات المحدد للأعمدة هو "نص". انقر فوق الزر بامتداد تي رمز لتغيير نوع البيانات. يمكنك تغييره إلى رقم أو خانة اختيار أو قائمة منسدلة أو مرفق ملف أو تصنيف أو أكثر.
- اضغط على رمز النقاط الست بالقرب من الزاوية العلوية اليسرى من الجدول. هنا يمكنك إدراج أعمدة وصفوف جديدة أو حذف الجدول بأكمله. يمكنك أيضًا إخفاء أعمدة معينة أو إظهارها ، أو تغيير خصائص أخرى للجدول.
كيفية إضافة كتل ارتباط الصفحة
كتل ارتباط الصفحة عبارة عن روابط تشغل السطر بأكمله على الصفحة. عند إضافة الارتباط ، يجب عليك الارتباط بالصفحة التي ستفتح عندما ينقر شخص ما عليها.
- اضغط على زائد زر لفتح القائمة المنسدلة لكتل المحتوى المتاحة.
- انقر فوق رابط الصفحة.
- من القائمة المنسدلة الجديدة ، اختر الصفحة التي ترتبط بها.
- سيظهر ارتباط صفحتك داخل قالب على الصفحة.
استخدام GitBook للتوثيق
GitBook هي أداة توثيق تستخدم مفاهيم التحكم في الإصدار مثل التفريع والدمج. يتيح ذلك لأكثر من عضو في الفريق العمل على الوثائق في وقت واحد. كما أنه يساعد على إدارة أي تعارضات تحدث.
يمكنك إضافة جميع أنواع كتل المحتوى إلى الصفحة. يمكنك استخدام العناوين أو الفقرات أو كتل التعليمات البرمجية أو النقاط النقطية لإعادة تنسيق المحتوى الخاص بك. يمكنك تغيير نوع التلميح والرسالة ونوع رمز التلميحات ، بالإضافة إلى تخصيص أعمدة الجدول.
تتيح لك علامة التبويب "الملفات" إدارة الصور ومرفقات الملفات التي تقوم بتحميلها على الموقع. تتيح لك ارتباطات الصفحات إنشاء روابط كبيرة يمكن للمستخدمين اكتشافها بسهولة.
إذا كنت تقوم بإنشاء وثائق متعلقة بلغة Go ، فيمكنك استخدام Godoc. يسمح لك Godoc بتوثيق كود Go الخاص بك تلقائيًا.
