انتقل إلى المحتوى
المستندات
إجراءات الصفحة

توثيق يبقى Markdown عاديًا

يحوّل jekyll-theme-modootoday ملفات GitHub Flavored Markdown القياسية إلى موقع توثيق مرتّب. يُقرأ الملف نفسه بوضوح على github.com وعلى GitHub Pages، وكنسخة Markdown لوكلاء الذكاء الاصطناعي.

ابدأ الآن تصفّح المكوّنات GitHub

لماذا قالب modoo.today

  • Markdown القياسية فقط تنبيهات وجداول وقوائم وكتل برمجية. لا HTML ولا Liquid ولا امتدادات kramdown في صفحاتك.
  • يعمل على GitHub Pages قالب يعتمد على Liquid وحدها لبناء github-pages الكلاسيكي، وJekyll 4 لما سوى ذلك.
  • مقروء للوكلاء لكل صفحة نسخة Markdown مطابقة لها بايتًا ببايت، إضافةً إلى llms.txt وllms-full.txt.

بداية سريعة

remote_theme

remote_theme: modootoday/jekyll-theme-modootoday@v1.4.1
plugins: [jekyll-remote-theme]

Gemfile

gem "jekyll-theme-modootoday", "~> 1.4"

_config.yml

theme: jekyll-theme-modootoday
permalink: pretty

مسارك في التوثيق

  1. ثبّت القالب على GitHub Pages أو Jekyll 4.
  2. اكتب صفحتك الأولى بلغة Markdown العادية.
  3. اختر من المكوّنات ومن صفحة جميع المكوّنات.
  4. اضبطه عبر الإعدادات وخصّص المظهر باستخدام الرموز المميّزة و_sass.
  5. اجعل موقعك مقروءًا للوكلاء بفضل نسخ Markdown وllms.txt.

ملاحظة

هذه الصفحة مترجمة عن الأصل الإنجليزي، وعند أي اختلاف يُعتمد النص الإنجليزي. الأدلة المرتبطة متاحة بالإنجليزية.

ابدأ الآن

ثبّت القالب اعرض جميع المكوّنات

تعديل هذه الصفحة