پیکربندی یک پروژه
/lore:init فقط چیزهای اساسی را پر می‌کند. بقیه‌ی موارد با /lore:config تنظیم و بازتنظیم می‌شوند، که هر زمان می‌توانید اجرا کنید. از هر سؤال می‌توانید رد شوید و دستور idempotent است.
/lore:config
چه چیزی را ویرایش می‌کند
| تنظیم | کارکرد |
|---|---|
| آدرس سایت پروژه | وب‌سایت محصول زنده. به‌اختیار به منابع مورد اعتماد افزوده می‌شود. |
| توضیح محصول | یک توضیح کوتاه از محصول. Lore صفحه‌ی خانه (docs/intro.md) را از روی آن به یک معرفی واقعی بازنویسی می‌کند و تگ‌لاین سایت را تنظیم می‌کند. |
| منابع مورد اعتماد | منابع تأییدشده و معتبر برای مستندسازی: مرکز راهنما، بلاگ، محصول زنده و … |
| قالب نگارش سند | از قالب پیش‌فرض همراه استفاده کنید، یا به یک فایل قالب سفارشی اشاره کنید. |
| رنگ برند | یک رنگ hex؛ سایه‌های رنگ اصلی را در استایل Docusaurus بازتولید می‌کند. |
| نام محصول | همه‌جا دوباره اعمال می‌شود: عنوان‌ها، پیکربندی، تیترها. |
| زبان مستندات | استایل (RTL یا LTR) را دوباره اعمال می‌کند و بومی‌سازی ویوئر را به‌روز می‌کند. |
| روشن/خاموش‌کردن Docusaurus | ویوئر را روشن کنید (اجرای افزودن Docusaurus) یا خاموش (حذف ویوئر، حفظ مستندات). |
منابع مورد اعتماد مهم‌اند
منابعی که پیکربندی می‌کنید معتبر می‌شوند: اسکیل‌ها آن‌ها را بر دانش بیرونی ترجیح می‌دهند و مستنداتی که با آن‌ها در تضاد باشد تحویل نمی‌دهند. تعریف خوب آن‌ها بزرگ‌ترین اهرم بر دقت مستندات است؛ تعریف انجام‌شدن را ببینید.
چه زمانی از آن استفاده کنیم
- درست بعد از
/lore:init، برای تکمیل پروژه. - هر زمان که منابع، نقش‌ها، برند یا زبان محصول تغییر کرد.
- برای تبدیل یک پروژه‌ی فقط-مستندات به یک سایت قابل‌مرور، یا برعکس.