llms.txt template and format
Open in the editor Opens as llms.txt, ready to edit. Nothing is uploaded.
The shape of it — edit here, or open the full template
Result
Runs entirely in this tab. Open the full editor to work on a real document.
llms.txt is a short Markdown file at the root of a site that says what the
site is and which pages are worth reading. This template follows the proposed
format; the structure is fixed enough to be recognisable and loose enough to be
written by hand in ten minutes.
The shape
Four things, in order:
- An
H1with the project or site name. - A single blockquote summarising it.
- Optional prose for context that does not fit the summary.
H2sections of links, each link followed by a colon and a note.
The blockquote is doing the most work. It is read first and often alone, so it has to carry the whole idea without depending on anything below it:
> One or two sentences describing what this is. This blockquote is the
> summary a language model reads first, so make it carry the whole idea.
Annotate every link
The note after the colon is the difference between this file and a sitemap:
- [Quickstart](https://example.com/docs/quickstart.md): install, configure
and run the first example in about five minutes.
“Quickstart” alone says nothing that the URL did not. The annotation says what is inside and roughly what it costs to read, which is what makes the list choosable rather than merely enumerable.
Point at Markdown where you can
Where a page has a Markdown source — quickstart.md rather than
quickstart.html — link that. It skips the navigation, the cookie banner and
the footer, all of which are noise around the content you meant to share. Where
only HTML exists, link the HTML; a working link beats a tidy one.
The Optional section means something
## Optional is the one heading with defined semantics in the format:
everything under it can be dropped when context is tight. Use it deliberately.
Changelogs, architecture notes and migration guides usually belong there;
the quickstart never does.
Keep it curated
The temptation is to list everything, which turns the file back into a sitemap and wastes the one advantage it has. If a section is past a dozen links, cut it to the pages that explain the most. An index that has to be read in full is not an index.
Common questions
- What is llms.txt?
- A proposed convention for a Markdown file at the root of a site — /llms.txt — that summarises what the site covers and links to the pages worth reading, each with a note on what it contains. The intent is to offer a clean, structured map instead of leaving a model to infer one from navigation chrome and marketing copy.
- How is it different from robots.txt or sitemap.xml?
- Purpose and audience. robots.txt grants or withholds permission to crawl; sitemap.xml enumerates every URL for completeness. llms.txt is curated and annotated — a short reading list of the pages that actually explain the thing, in the order a newcomer should meet them.
- Why is it Markdown rather than XML or JSON?
- Because it is written for a reader that handles prose well. The annotation after each link is the useful part, and a schema-shaped format would have nowhere natural to put it. Markdown also means a human can open the file and immediately see whether it is right.
- What is the Optional section for?
- Links that can be skipped when context is short. The format gives that heading a specific meaning, so it is the one section name worth keeping verbatim — anything under it is explicitly droppable, which is a useful signal to send deliberately.
- How long should it be?
- Short. It is an index, not a corpus — if a section grows past roughly a dozen links it has stopped being curation. Point at the pages that explain the most and let those pages carry the detail.
- Is it a standard?
- Not a ratified one. It is a proposal that has seen real adoption, particularly among documentation sites, and consumption varies by tool. The cost is a single small file, which is why plenty of sites publish one without waiting for the question to settle.