مستنداتی که Markdown ساده می‌مانند
jekyll-theme-modootoday فایل‌های استاندارد GitHub Flavored Markdown را به یک سایت مستندات مرتب تبدیل می‌کند. همان فایل در github.com، در GitHub Pages و به‌صورت نسخهٔ Markdown برای عامل‌های هوش مصنوعی خوانا است.
چرا پوستهٔ 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
مسیر شما در مستندات
- پوسته را روی GitHub Pages یا Jekyll 4 نصب کنید.
- نخستین صفحهٔ خود را با Markdown ساده بنویسید.
- از میان مؤلفه‌ها و صفحهٔ همهٔ مؤلفه‌ها انتخاب کنید.
- در پیکربندی تنظیم کنید و ظاهر را با توکن‌ها و
_sassسفارشی کنید. - با نسخه‌های Markdown و
llms.txtسایت را برای عامل‌ها خوانا کنید.
یادداشت
این صفحه از متن اصلی انگلیسی ترجمه شده است؛ در صورت تفاوت، متن انگلیسی معتبر است. راهنماهای پیوندشده به انگلیسی هستند.