تخطَّ إلى المحتوى الرئيسي
خصم ٥٠٪ جميع الخطط، لفترة محدودة. تبدأ من $2.48/mo
MkDocs

MkDocs

يحوّل MkDocs مجلدًا من ملفات Markdown إلى موقع توثيق عبر ملف إعدادات YAML واحد. يأتي بخادم تطوير بإعادة تحميل حيّة، وينتج HTML ثابتًا يمكنك استضافته في أي مكان. مرخّص بموجب BSD-2-Clause وبأكثر من 22,300 نجمة على GitHub.

نظرة سريعة

22.4k

نجوم GitHub

1

مشاهدات الصفحة

الرخصة BSD-2-Clause الإصدار Latest OS Ubuntu Server 24.04 LTS Min RAM 1 GB IP IPV4,IPV6

الوصول

  • افتح: http://SERVER_IP

تحرير المحتوى ونشره

1. أضف ملفات Markdown أو عدّلها: /opt/mkdocs/docs

2. إذا أضفت صفحات أو أعدت تسميتها، فحدّث /opt/mkdocs/mkdocs.yml for navigation.

3. أعد بناء الموقع:

/opt/mkdocs/venv/bin/mkdocs build --clean \
  --config-file /opt/mkdocs/mkdocs.yml \
  --site-dir /opt/mkdocs/site

يقدّم Nginx الملفات المولَّدة من: /opt/mkdocs/site

لا حاجة لإعادة تشغيل Nginx بعد إعادة البناء.

المسارات المهمة

  • المشروع: /opt/mkdocs
  • المحتوى: /opt/mkdocs/docs
  • الإعدادات: /opt/mkdocs/mkdocs.yml
  • ناتج البناء: /opt/mkdocs/site
  • البيئة الافتراضية لـ Python: /opt/mkdocs/venv
  • ملف MkDocs التنفيذي: /opt/mkdocs/venv/bin/mkdocs
  • إعدادات Nginx: /etc/nginx/sites-available/mkdocs.conf

النطاق وHTTPS

1. وجّه نطاقك إلى عنوان IP للخادم.

2. عدّل إعدادات Nginx واستبدل server_name _; بنطاقك (مثل server_name <YOUR_DOMAIN>;):

vim /etc/nginx/sites-available/mkdocs.conf

3. اختبر الإعدادات:

nginx -t

4. ثبّت Certbot:

apt install -y certbot python3-certbot-nginx

5. أنشئ شهادة Let's Encrypt:

certbot --nginx --non-interactive --agree-tos --email <YOUR_EMAIL> -d <YOUR_DOMAIN>

6. أعد تحميل Nginx:

systemctl reload nginx

7. حدّث رابط موقع MkDocs: استبدل site_url: 'http://<SERVER_IP>/' بـ site_url: 'https://<YOUR_DOMAIN>/' in /opt/mkdocs/mkdocs.yml.

8. أعد بناء الموقع:

/opt/mkdocs/venv/bin/mkdocs build --clean \
  --config-file /opt/mkdocs/mkdocs.yml \
  --site-dir /opt/mkdocs/site

9. افتح متصفحك وزُر: https://<YOUR_DOMAIN>

ملاحظات

  • يجب إعادة بناء تغييرات Markdown قبل ظهورها على الموقع العام.
  • Nginx serves the generated files from /opt/mkdocs/site.
  • غيّر mkdocs.yml وإعدادات المشروع بحسب تفضيلاتك.

المزيد في أدوات التطوير

تطبيقات ذات صلة.

انشر MkDocs الآن. تبدأ من 2.48 $/شهر.