llms.txt في Docusaurus
تُعد مواقع الوثائق مرشحة مثالية لاستخدام llms.txt. وفي Docusaurus، لا يتطلب الأمر سوى ملف واحد في static/.
آخر تحديث:
إلى أين يذهب الملف
ينسخ Docusaurus كل شيء في static/ الدليل إلى جذر الموقع المبني. والملف الموجود في static/llms.txt يُقدَّم على العنوان /llms.txt. وبما أن Docusaurus يوفّر الوثائق، فإن llms.txt التي ترسم خريطة لصفحات التوثيق الأساسية ذات قيمة خاصة لمساعدات الذكاء الاصطناعي.
أبقِ الملف قصيراً ومقصوداً. وجّه المساعدات إلى صفحات النظرة العامة ومراجع API والتوثيق المعنون
بالإصدار وسجل التغييرات وسياسة الدعم، بدلاً من كل إدخال في الشريط الجانبي. وإذا كان التوثيق
يستخدم مساراً غير جذري baseUrl، وتحقق من مسار البناء وعنوان URL العام قبل الإعلان
عن الملف.
الطريقة: مجلد static/
- أضف الملف:
touch static/llms.txt - أدرج صفحات التوثيق الأكثر فائدة لديك (راجع دليل إجرائي):
# Your Project Docs
> Documentation for Your Project: guides, API reference, and tutorials.
## Guides
- [Getting started](https://yourdomain.com/docs/intro): installation and first steps.
- [Configuration](https://yourdomain.com/docs/config): all options explained.
## Reference
- [API reference](https://yourdomain.com/docs/api): full endpoint catalog.
- البناء والنشر:
npm run build.
انتبه إلى baseUrl
التحقق من الإعداد
curl -sI https://yourdomain.com/llms.txt | grep -i content-type
# expect: content-type: text/plain
استضافة الوثائق على GitHub Pages؟ راجع دليل GitHub Pages من أجل التنبيه المتعلق بالمسار الجذري. ولنسخة كاملة المحتوى، أضف
llms-full.txt, ثم تحقّق من كليهما باستخدام
المدقّق.