Docs for AI tools (llms.txt)
The files that the docs site writes for AI tools, and the address of each file.
The docs site writes text files for AI tools each time the site is built. The files contain the same content as the published pages.
Files
| File | Address | Content |
|---|---|---|
llms.txt | https://ijewel3d.com/docs/llms.txt | An index. It has a short description of the site, a link to the full file and a list of pages for each sidebar section. |
llms-full.txt | https://ijewel3d.com/docs/llms-full.txt | The text of the sidebar pages in one file. A --- line divides the pages. |
| Markdown copy | The page address with .md in place of .html | The Markdown source of one page. |
Markdown copy of a page
| Page address | Markdown address |
|---|---|
https://ijewel3d.com/docs/developers/viewer/introduction.html | https://ijewel3d.com/docs/developers/viewer/introduction.md |
Each link in llms.txt goes to the Markdown copy of a page.
Which file to use
| Task | File |
|---|---|
| Let a tool find the correct page | llms.txt |
| Give a tool all the docs in one request | llms-full.txt |
| Give a tool one page | The Markdown copy of that page |
Notes
| Item | Detail |
|---|---|
| Page list | llms.txt and llms-full.txt contain the pages that are in the sidebar. |
| Front matter | The Markdown copy keeps the front matter of the page. llms-full.txt removes it. |
| Comments | The build removes Markdown comments from each copy. |