مستندات - مجتمع - مستندات المطورين - تقارير الأخطاء - تقارير الأخطاء
مرحبًا بك في GitBook ، منصة إدارة المعرفة التقنية للفرق.
يحتوي هذا المستودع على رمز المصدر المفتوح المستخدم لتقديم المحتوى المنشور لـ GitBook.
ابدء
المساهمة
أنواع المساهمات
الترخيص
شكر وتقدير
Legacy Gitbook
لتشغيل نسخة محلية من هذا المشروع ، يرجى اتباع هذه الخطوات البسيطة.
node.js (الإصدار:> = 18.x)
كعكة
استنساخ الريبو في مستودع جيثب العام . إذا كنت تخطط لتوزيع الرمز ، فاحرص على امتثال رمز المصدر للامتثال لـ GNU GPLV3. لاستنساخ مستودع خاص ، الحصول على ترخيص تجاري.
git clone https://github.com/gitbookIO/gitbook.git
تأكد من أنك تستخدم إصدار node
للمشروع. سيؤدي تشغيل nvm use
إلى تغيير الإصدار المحلي إلى الإصدار الصحيح.
تثبيت تبعيات المشروع من خلال BUN.
bun install
ابدأ خادم التطوير المحلي.
bun dev
افتح مساحة gitbook المنشورة في متصفح الويب الخاص بك ، وقادها مع http://localhost:3000/
.
أمثلة:
http: // localhost: 3000/docs.gitbook.com
http: // localhost: 3000/open-source.gitbook.io/midjourney
يمكن الوصول إلى أي موقع gitbook المنشور من خلال مثيل التطوير المحلي الخاص بك ، وسيتم انعكاس أي تحديثات تجريها على قاعدة الكود في متصفحك.
bun format
: تنسيق الرمز
bun lint
: LINT الرمز
سيتم اختبار جميع عمليات السحب مقابل كل من الاختبار البصري والعروض لمنع الانحدارات.
محرك عرض GitBook مفتوح المصدر بالكامل ومبني على قمة Next.js. توجه إلى دليلنا المساهم لمعرفة المزيد حول سير العمل عند إضافة طلب السحب الأول.
نشجعك على المساهمة في GitBook لمساعدتنا في بناء أفضل أداة لتوثيق المعرفة التقنية. إذا كنت تبحث عن بعض الطرق السريعة للمساهمة ، فاستمر في القراءة لمعرفة المزيد عن المساهمات الشائعة.
يتم تقديم GitBook UI باستخدام مجموعة من ملفات الترجمة الموجودة في packages/gitbook/src/intl/translations
. نرحب بجميع الترجمات الإضافية لواجهة المستخدم.
واجه خطأ أو ابحث عن مشكلة تود إصلاحها؟ يساعدنا مساعدتنا في إصلاح المشكلات المتعلقة بـ GitBook بشكل كبير على تحسين التجربة للجميع. توجه إلى قسم المشكلات في هذا المستودع لمعرفة المزيد حول أنواع الأخطاء التي يمكنك مساعدتها بالفعل.
تحذير
على الرغم من أنه من الممكن استضافة هذا المشروع ، فإننا لا نوصي بهذا ما لم تكن متأكدًا من أن هذا الخيار يناسب حاجتك.
تبحث لإضافة ميزة محددة في GitBook؟ توجه إلى دليلنا المساهم للبدء.
يستضيف هذا المشروع مسؤولية الحفاظ على التحديثات المستقبلية ودمجها . لا يمكننا ضمان الدعم أو الصيانة أو التحديثات لتخليص الحالات التي تم استضافتها ذاتيا لهذا المشروع.
نريد أن نجعل من السهل قدر الإمكان لمجتمعنا التعاون ودفع مستقبل GitBook ، ولهذا السبب نشجعك على المساهمة في منتجاتنا مباشرة بدلاً من إنشاء نسختك الخاصة.
يتيح لك هذا المشروع أن يستضيفوا جزءًا من تقديم محتوى Gitbook المنشور. الاستضافة الذاتية لديها إيجابيات وسلبيات.
على الجانب المحترف ، يمكنك تخصيص مظهر ومظهر المحتوى الخاص بك ، وتضمين وثائقك بشكل أفضل في التطبيق الخاص بك.
على الجانب CON ، تصبح مسؤولاً عن موثوقية موقعك المنشور ، والحفاظ على تحديث العارض مع التغييرات التي تم إجراؤها على منصة GitBook.
موزعة تحت رخصة GNU GPLV3.
إذا كنت تخطط لتوزيع الرمز ، فيجب عليك جعل الرمز المصدري عامًا للامتثال لـ GNU GPLV3. لاستنساخ مستودع خاص ، الحصول على ترخيص تجاري.
انظر LICENSE
لمزيد من المعلومات.
[!
<a href = "https://gitbook.com"> <imgsrc = "https://img.shields.io/static/v1؟message=documented٪20on٪20Gitbook&Logo=gitbook&ogocolor=fffff&label=٪22 " /> </a>
لن يكون GitBook ممكنًا بدون هذه المشاريع:
Next.js
كعكة
Tailwind CSS
حركة الإطارات
يتم الآن إهمال نسختنا السابقة من GitBook و CLI. لا يزال بإمكانك عرض المستودع القديم وهو يرتكب هذا الفرع.