What is llms.txt?
llms.txt: llms.txt is a Markdown file at a site's root that gives AI models a short summary and a curated list of links to the site's most useful docs.
llms.txt is a proposal, published by Jeremy Howard in September 2024, for a file that helps large language models use a website at inference time. HTML pages are full of navigation, scripts and layout that waste a model's context window. A plain Markdown file at /llms.txt says what the site is and points to clean versions of the pages that matter, so an agent can read a library's docs in a few requests instead of crawling it.
The format
- An
#heading with the project name. This is the only required part. - A
>blockquote with a one or two sentence summary. - Optional paragraphs with the details a model needs before anything else, such as install steps and rules.
##sections, each a list of links in the form[Title](url): note. A section namedOptionalmarks links a model can skip when context is short.
The proposal also suggests serving a Markdown copy of each page at the same URL with .md added. A common companion file, llms-full.txt, is not part of the proposal but is widely used: it puts all the docs in one file, so an agent can load everything with one request.
What makes a good one
- Rules before links. The few things a model gets wrong without being told (imports, required setup, naming) belong at the top, in plain imperative sentences.
- One line per page that says what it is for, so the model can pick the right link without opening all of them.
- Generated from the source, not written by hand, so it never drifts from the code.
- Short enough to fit in context with room to spare. Put the long reference in
llms-full.txtand the per-page.mdfiles.
How MiniDev UI uses it
MiniDev UI publishes /llms.txt with a quick start to follow exactly, the rules for generating code with the kit (Base UI's render prop instead of asChild, semantic tokens only, the shadow set, the spring presets) and one line for every component. /llms-full.txt has every component in one file, and every docs page has a Markdown twin at /docs/<name>.md, for example /docs/button.md, with purpose, install command, props and examples. All three are generated from the registry on each build.
To use it, tell your agent: "Read https://ui.minidev.pro/llms.txt before writing any UI." Or put that line in your AGENTS.md so every session starts with it.