كيفية إنشاء ويكي داخلي بسيط باستخدام Gitbook

كيفية إنشاء ويكي داخلي بسيط باستخدام Gitbook

GitBook عبارة عن نظام أساسي يتيح لك إنشاء مواقع توثيق أو مواقع wiki الخاصة بالشركة. يمكنك استخدامه لتوثيق جميع أنواع الأشياء ، من التعليمات البرمجية إلى واجهات برمجة التطبيقات وكيفية استخدام منتج البرنامج.



يستخدم GitBook عملية مماثلة لمستودعات GitHub. تعمل النسخة الرئيسية من الوثائق كنسخة 'رئيسية'. يمكنك بعد ذلك إنشاء 'مسودات' تشبه 'الفروع'.





تسمح هذه العملية للعديد من المستخدمين بالعمل في موقع توثيق واحد أثناء معالجة أو منع التعارضات. كما يسمح للتغييرات من الفروع المختلفة بالمرور بعملية مراجعة قبل دمجها.





كيف تبدأ في استخدام GitBook

يمكنك الاختيار من بين عدة تسعير GitBook الخطط. سيعتمد التسعير على ما إذا كنت تستخدم GitBook لمشاريع مفتوحة المصدر أو للاستخدام الشخصي أو تعاون فريق خاص. GitBook مجاني للاستخدام إذا كنت تستخدمه لمشاريع مفتوحة المصدر.

يدعم GitBook Markdown ، وهي لغة ترميز شائعة لها العديد من الفوائد للكتابة أو التوثيق على الويب.



xbox one لن يتصل بوحدة التحكم

يتكامل GitBook أيضًا مع GitHub ، منصة لاستضافة وتخزين وتحرير التعليمات البرمجية . يمكنك ربط حساب GitBook الخاص بك مباشرةً بحساب GitHub الخاص بك عن طريق تسجيل الدخول باستخدام بيانات اعتماد GitHub الخاصة بك.

  1. اشترك في GitBook. إذا كان لديك حساب GitHub الخاص بك ، فيمكنك النقر فوق اشترك مع جيثب .
  2. بمجرد تسجيل الدخول ، سيعيد GitBook توجيهك إلى ويكي داخلي جديد. سيقوم أيضًا بتعبئة الويكي مسبقًا ببعض المحتوى النموذجي.

نظرة عامة على واجهة GitBook

يحتوي GitBook على العديد من الوظائف التي تتيح لك إنشاء موقع التوثيق الخاص بك وإجراء تغييرات عليه.





كيفية توصيل mac بـ roku
  1. تتيح لك اللوحة العلوية إنشاء مسودات جديدة أو عرض محفوظات التغييرات أو عرض أي مناقشات أو مرفقات أخرى.
  2. يسمح لك الشريط الجانبي الموجود في أقصى اليسار بإنشاء مسافات متعددة. يمكنك استخدام مساحات منفصلة لمشاريع مختلفة بحيث يمكنك فصل وتنظيم مناطق التوثيق الخاصة بك. يمكنك توسيع الشريط الجانبي أو إغلاقه.
  3. تعمل اللوحة اليسرى كقائمة لموقع التوثيق. يمكنك عرض الصفحات داخل موقع التوثيق الخاص بك ، واستخدامها لإنشاء مجموعات وصفحات متداخلة. يمكنك أيضًا التنقل عبر الموقع باستخدام الروابط المتوفرة.
  4. تتضمن اللوحة السفلية أزرارًا حيوية لعملية التحكم في الإصدار. يمكنك إضافة اسم لمسودتك أو دمج تغيير أو إرسال التغيير للمراجعة.

كيفية إنشاء مسودة جديدة

يمكنك إنشاء مسودة جديدة عن طريق إنشاء طلب تغيير جديد وإجراء التغييرات بداخله.

  1. في اللوحة العلوية ، انقر فوق تغيير الطلبات .
  2. في اللوحة الجديدة التي تظهر على الجانب الأيمن ، انقر فوق مسودة التبويب. سيُظهر لك هذا كل مسوداتك النشطة.
  3. من هنا ، يمكنك النقر فوق مسودة موجودة لفتحها. لإنشاء مسودة جديدة ، انقر فوق طلب تغيير جديد ، وانتظر حتى انتهاء تحميل الصفحة.
  4. في اللوحة السفلية ، انقر فوق أدخل الموضوع . سيؤدي هذا إلى فتح نافذة حيث يمكنك تسمية المسودة الجديدة. فمثلا، صفحة جديدة - كيفية إعداد Codebase .

كيفية إنشاء الصفحات والمجموعات

بمجرد أن يكون لديك مسودة ، يمكنك البدء في إجراء تغييرات على الوثائق. يخزن GitBook تغييراتك داخل المسودة ، حتى لا تؤثر على النسخة الرئيسية. يمكنك استخدام الشريط الجانبي الأيسر لإضافة صفحات ومجموعات صفحات.





  1. قم بإنشاء صفحة جديدة من خلال النقر على صفحة جديدة في الجزء السفلي من الشريط الجانبي ، واختيار صفحة وثيقة جديدة من القائمة المنسدلة. بدلاً من ذلك ، يمكنك التمرير أسفل صفحة موجودة والنقر فوق الزر الأزرق زائد زر.
  2. لإنشاء مجموعة صفحات جديدة ، انقر فوق صفحة جديدة ، وحدد ملف مجموعة جديدة خيار من القائمة المنسدلة.
  3. يمكنك إعادة تسمية الصفحة بالنقر فوق النقاط الثلاث الموجودة بجوار الصفحة أو المجموعة ، والاختيار إعادة تسمية .
  4. ابدأ في إضافة محتوى لملء صفحتك الجديدة. يمكنك إضافة محتوى بسيط مثل نص أو عناوين. يتيح لك GitBook أيضًا إضافة كتل محتوى أخرى مثل الصور أو مرفقات الملفات أو الجداول أو علامات التبويب أو مقتطفات التعليمات البرمجية. هناك أيضًا خيار لإضافة عمليات تكامل أخرى مثل تضمين YouTube أو محتوى محرر مستندات Google.
  5. اضغط على عرض مختلف في اللوحة السفلية لعرض الاختلافات بين المسودة ونسخة التوثيق الأصلية الأصلية.
  6. بمجرد الانتهاء من كتابة المحتوى الخاص بك ، يمكنك النقر فوق دمج و إرسال ودمج ، أو تقديم للمراجعة .

يمكنك الوصول إلى رابط المشاركة من اللوحة العلوية في GitBook. ستحتاج إلى الخروج من المسودة وعرض نسخة التوثيق الرئيسية لتتمكن من عرض الارتباط.

  1. بشكل افتراضي ، يكون ظهور موقع التوثيق الخاص بك 'غير مدرج'. هذا يعني أنه يمكنك الوصول إلى موقع التوثيق باستخدام رابط خاص ، وليس عبر محركات البحث. في اللوحة العلوية ، انقر فوق غير مدرج زر.
  2. حدد إعدادات الرؤية المطلوبة من القائمة المنسدلة. لاحظ أن GitBook قد يقفل إعدادات رؤية معينة ، وقد تحتاج إلى الترقية للوصول إليها.
  3. أسفل قائمة إعدادات الرؤية ، يوجد ارتباط يمكنك مشاركته مع المستخدمين الآخرين الذين سيستخدمون موقع التوثيق الخاص بك. انسخ هذا الرابط لمشاركته مع الآخرين.
  4. تحت الرابط ، انقر فوق إعدادات الارتباط والمجال . هذا هو المكان الذي يمكنك فيه ربط اسم مجال مخصص أو تعديل جزء من عنوان URL. إذا كنت تستخدم مجالًا خاصًا ، فيمكنك عرض ملفات وثائق Gitbook ل حول كيفية تكوين DNS الخاص بك بشكل صحيح.

إنشاء التوثيق باستخدام GitBook

يتيح لك GitBook إمكانية إنشاء مواقع التوثيق أو مواقع wiki الخاصة بالشركة والعمل عليها بشكل تعاوني. يستعير GitBook المفاهيم من GitHub مثل الفروع ودمجها للتحكم في نسخة رئيسية وإدارة أي تعارضات.

يمكنك إنشاء مسودة جديدة لإضافة التغييرات الفردية الخاصة بك إلى الوثائق. ضمن المسودة ، يمكنك إجراء تغييرات على المحتوى ، بالإضافة إلى إضافة صفحات أو مجموعات صفحات جديدة. بمجرد الانتهاء من إجراء التغييرات ، يمكنك إما دمجها أو إرسالها للمراجعة.

إذا كنت تقوم بإنشاء وثائق داخلية لرمز Java الخاص بك ، فقد ترغب في استكشاف Javadoc. يسمح لك Javadoc بتوثيق كود Java الخاص بك تلقائيًا.