如何建立 llms.txt 檔案
發佈:
撰寫一份 llms.txt 檔案大約只需十分鐘。本指南會依序帶你走過每一個部分,最後並提供一份你可以直接貼上並加以調整的檔案。
1. 從 H1 標題開始
第一行必須是單一的 H1 —— 也就是你的專案或網站名稱。它是這個格式中唯一嚴格必填的元素。
# Acme Docs
2. 加上區塊引言摘要
緊接在標題下方,加上一到兩句的區塊引言(blockquote)。這是語言模型最先讀到的脈絡,所以請寫得具體:說明這個網站是什麼、以及它是給誰用的。
> Acme is a payments API. This file links to the docs an LLM needs to integrate and debug Acme.
3.(選用)加上幾行說明文字
在任何章節標題之前,你可以加上一般的段落文字,提供額外的指引說明。這裡不要使用標題 —— 控制在一兩句話即可。
4. 將連結歸類在各 H2 章節之下
每個章節都是一個 H2 標題,後面接著一份 markdown 清單。每個項目都是一個連結,並可在冒號後附上選擇性的描述。
## Docs - [Quickstart](https://acme.com/docs/quickstart): Integrate in five minutes - [API reference](https://acme.com/docs/api): Every endpoint and parameter ## Examples - [Sample app](https://acme.com/examples/app): A working end-to-end example
請使用絕對的 https 網址,並讓描述聚焦在開發者或模型真正需要知道的內容上 —— 而不是行銷文案。
5. 用「Optional」章節放置非必要項目
一個名稱正好為 ## Optional 的章節具有特殊意義:當需要較短的脈絡時,其中的連結可以被略過。把變更日誌、部落格文章與次要參考資料放在這裡。
6. 託管在網站根目錄
將檔案以 Content-Type: text/plain 提供於 https://yourdomain.com/llms.txt。大型網站通常也會發布一份 llms-full.txt,內含完整展開的內容。
7. 上線前先驗證
把你的網域貼進驗證工具。它會檢查結構、確認每個連結確實可以解析,並列出究竟有哪些地方需要修正。目標是拿到 100/100。