شروع سریع

به‌محض اینکه Lore نصب و فعال شد، از یک مخزن خالی تا مستندات منتشرشده در چهار حرکت پیش می‌روید.

۱. اسکفولد

cd <your-empty-or-existing-project>
/lore:init

‏/lore:init سه چیز اساسی را می‌پرسد (نام محصول، زبان مستندات، و اینکه آیا ویوئر Docusaurus نصب شود)، سپس لایه‌ی مستندات (docs/ و پیکربندی پروژه) و، در صورت انتخاب، یک سایت Docusaurus را اسکفولد می‌کند.

• Docusaurus اختیاری است. برای مستندات فقط-Markdown گزینه‌ی No را انتخاب کنید و بعداً یک سایت قابل‌مرور اضافه کنید.
• زبان، استایل را تعیین می‌کند. یک زبان راست‌به‌چپ (فارسی، عربی، …) فونت فارسی self-hosted و چیدمان RTL می‌گیرد؛ زبان‌های چپ‌به‌راست استایل استاندارد می‌گیرند.
• در مخزن‌های موجود امن است. ‏/lore:init فقط لایه‌ی مستندات را اضافه می‌کند و هرگز فایل‌های شما را بازنویسی نمی‌کند.

بقیه را، یعنی آدرس سایت، توضیح محصول، منابع مورد اعتماد و رنگ برند، هر زمان با /lore:config پر کنید.

۲. تولید

اسکیلی را اجرا کنید که با ورودی‌تان هم‌خوان است:

• lore:figma-to-doc برای فایل‌های طراحی
• lore:brief-to-doc برای بریف، PRD یا یوزر استوری
• lore:site-to-doc برای یک محصول زنده

۳. بازبینی

پیش از تحویل در برابر تعریف انجام‌شدن اعتبارسنجی کنید:

lore:doc-reviewer

اسکیل‌های تولیدکننده هم در پایان خودکار یک اعتبارسنج فقط-خواندنی اجرا می‌کنند، پس کیفیت پیش از انتشار هر چیزی تضمین می‌شود.

۴. استقرار

مستندات فقط-Markdown را تحویل دهید، یا سایت استاتیک را بسازید و خروجی را روی هر هاستی مستقر کنید:

npm run build     # خروجی استاتیک در build/ (پروژه‌های Docusaurus)

پوشه‌ی build/ را روی هر هاست استاتیکی مستقر کنید: Cloudflare Pages، Netlify، Vercel، GitHub Pages، یا سرور خودتان.