LLMs.txt
mdui 提供了 llms.txt 與 llms-full.txt,用於為 LLM(大型語言模型)提供準確、可引用的上下文,幫助 AI 更可靠地回答 mdui 相關問題。
使用 llms.txt 為 AI 提供上下文
兩個入口:
llms.txt:https://www.mdui.org/zh-tw/docs/2/llms.txtllms-full.txt:https://www.mdui.org/zh-tw/docs/2/llms-full.txt
llms.txt 是精簡索引,適合讓可連網的模型依連結抓取所需的 Markdown 頁面,或先快速掌握專案概覽。
llms-full.txt 則包含完整上下文,涵蓋 llms.txt 中的所有頁面內容,適合模型無法連網或需一次性提供完整上下文的情境。
文件的 Markdown 版本
每個文件頁面都提供了對應的 Markdown 版本:在頁面網址結尾加上 .md 即可(首頁則加上 index.md)。
例如:
https://www.mdui.org/zh-tw/docs/2/components/button → https://www.mdui.org/zh-tw/docs/2/components/button.md
https://www.mdui.org/zh-tw/docs/2/ → https://www.mdui.org/zh-tw/docs/2/index.md
可直接將該 Markdown 連結或其純文字作為上下文,以獲得更聚焦、準確的回答。
在 ChatGPT、Claude 等 LLM 中如何使用
根據模型是否支援連網/檔案上傳,可選擇以下一種或組合使用:
直接貼上:將
llms-full.txt的內容作為系統提示或第一則訊息。範例:“以下是 mdui 的上下文。請嚴格依據它回答後續問題;若有衝突,以該上下文為準:\n\n[貼上 llms-full.txt 內容]”。
上傳檔案:上傳
llms-full.txt(或llms.txt),並在第一則提示說明“以附件為主要上下文”。範例:“請基於附件中的 mdui 文件,給出
<mdui-button>的用法與常見的陷阱”。線上讀取:在對話中提供
llms.txt或llms-full.txt的連結。範例:“請讀取並遵循 https://www.mdui.org/zh-tw/docs/2/llms-full.txt 作為上下文,回答我關於 mdui 的問題”。
指向特定頁面:只討論特定元件/函式時,直接提供該頁面的 Markdown 網址。
範例:“請閱讀 https://www.mdui.org/zh-tw/docs/2/components/button.md ,並根據該文件給出三項最佳實踐”。
提示:你可以點選頁面右上角的 llms-full.txt 作為上下文在 ChatGPT 中開啟。