सामग्री पर जाएँ
Blume
Esc
↑↓नेविगेट↵खोलें⌘Jप्रीव्यू
इस पेज पर

llms.txt

llms.txt इंडेक्स और llms-full.txt कॉर्पस जो Blume कोडिंग एजेंट्स तथा चैट असिस्टेंट्स के लिए जनरेट करता है, वह details ब्लॉक जो उन्हें बताता है कि आपके उत्पाद का उपयोग कब करना है, और किसी पेज को कैसे बाहर रखें।

Blume आपके डॉक्स के मशीन-पठनीय संस्करण उत्सर्जित करता है जिन्हें कोडिंग एजेंट और चैट असिस्टेंट उपयोग कर सकते हैं। यह डिफ़ॉल्ट रूप से चालू रहता है; इसे बंद करने के लिए llmsTxt: false सेट करें:

agents: {
  llmsTxt: false,
}

सक्षम रहने पर, blume build आपकी साइट के रूट में दो फ़ाइलें लिखता है:

  • /llms.txt — एक संक्षिप्त इंडेक्स: आपकी साइट का शीर्षक और विवरण, फिर प्रत्येक पेज की एक लिंक्ड सूची उसके सारांश के साथ (उसका मेटा विवरण: यदि पेज seo.description सेट करता है तो वह, अन्यथा description), ऐसे सेक्शनों में व्यवस्थित जो आपके साइडबार को प्रतिबिंबित करते हैं — फ़ोल्डर और समूह शीर्षक बन जाते हैं, ताकि एजेंट डॉक्स की संरचना देखे, न कि एक सपाट पिंड।
  • /llms-full.txt — संपूर्ण कॉर्पस: प्रत्येक पेज का पूरा Markdown मुख्य भाग, उसके स्रोत URL के साथ, एक ही फ़ाइल में।

ड्राफ़्ट पेज, साइडबार से छिपाए गए पेज (sidebar.hidden, या शीर्ष-स्तरीय hidden शॉर्टहैंड), और noindex पेज बाहर रखे जाते हैं — जनरेट किए गए API संदर्भ पेजों को छोड़कर, जिनका दोनों फ़ाइलों में स्थान noindex के बजाय नीचे दिए गए openapi द्वारा निर्धारित होता है। deployment.site सेट करें ताकि लिंक और स्रोत URL निरपेक्ष पतों में हल हों।

विकल्प

llmsTxt एक ऑब्जेक्ट रूप भी लेता है जिसमें इन फ़ाइलों की सामग्री नियंत्रित करने के लिए नॉब्स होते हैं। यदि आपका API संदर्भ किसी प्लेसहोल्डर या उदाहरण स्पेक का दस्तावेज़ीकरण करता है, तो उसके जनरेट किए गए पेजों को दोनों फ़ाइलों से बाहर रखने के लिए openapi: false सेट करें:

agents: {
  llmsTxt: {
    enabled: true, // default
    openapi: false, // exclude generated API reference pages
  },
}

ऑब्जेक्ट रूप details भी लेता है: Markdown जो llms.txt में शीर्षक और सारांश के ठीक बाद, पेज सेक्शनों से पहले रखा जाता है — llms.txt स्पेक का मुक्त-रूप “details” ब्लॉक। यही वह जगह है जहाँ एजेंट्स को बताया जाता है कि आपके उत्पाद का सहारा कब लेना है और उसे कैसे कॉल करना है, जिसे रेडीनेस स्कैनर स्पष्ट रूप से खोजते हैं; एक इंस्टॉल कमांड और पैकेज नाम भी यहीं आते हैं। स्पेक वहाँ शीर्षकों को छोड़कर कोई भी Markdown रखने की अनुमति देता है, क्योंकि शीर्षकों को वह आगे आने वाले लिंक सेक्शनों के लिए आरक्षित रखता है, इसलिए अनुच्छेद या सूचियाँ लिखें:

agents: {
  llmsTxt: {
    details:
      "Reach for Acme when a project needs hosted feature flags. Install the CLI with `npm install -g acme`; the API reference below covers every endpoint.",
  },
}

जनरेट किए गए सेक्शन

llms.txt दो जनरेट किए गए सेक्शनों के साथ समाप्त होता है जिन्हें किसी कॉन्फ़िगरेशन की आवश्यकता नहीं होती। Agent skills आपकी साइट की अपनी स्किल और agents.skills के माध्यम से प्रकाशित प्रत्येक स्किल को उसके विवरण के साथ सूचीबद्ध करता है (जहाँ स्किल बताती है कि उसका उपयोग कब करना है)। Agent resources बिल्ड द्वारा उत्सर्जित प्रत्येक मशीन-पठनीय आर्टिफ़ैक्ट को लिंक करता है — llms-full.txt, प्रति-पेज रॉ Markdown मिरर, MCP सर्वर और उसका डिस्कवरी दस्तावेज़, स्किल्स इंडेक्स, API कैटलॉग, AI कैटलॉग, agent-readability.json, और साइटमैप — प्रत्येक केवल तभी जब वह मौजूद हो, ताकि जो एजेंट llms.txt के अलावा कुछ न पढ़े, वह भी पूरी सतह पा सके।

किसी पेज को बाहर रखना

किसी व्यक्तिगत पेज को दोनों फ़ाइलों से बाहर रखने के लिए, उसके फ्रंटमैटर में ai.exclude सेट करें:

---
title: Internal notes
ai:
  exclude: true
---

पेज फिर भी रेंडर होता है, सर्च में बना रहता है, और साइटमैप में अपना स्थान बनाए रखता है — केवल llms.txt फ़ाइलें और आपकी साइट की स्किल में मौजूद पेज मैप ही उसे छोड़ते हैं।

अपनी स्वयं की फ़ाइल लाना

किसी भी फ़ाइल पर पूर्ण नियंत्रण लेने के लिए, अपने public/ फ़ोल्डर में अपनी स्वयं की llms.txt या llms-full.txt जोड़ें। कस्टम फ़ेविकॉन की तरह, इसे स्वचालित रूप से उठा लिया जाता है और यह जनरेट की गई फ़ाइल के स्थान पर भेजी जाती है — एक को ओवरराइड करें और Blume फिर भी दूसरी जनरेट करता है।

अंतिम अपडेट

क्या यह पेज सहायक था?