llms.txt example for documentation sites
No signup, no email. The checker reads only public files and gives a plain-English fix list.
Open the llms.txt generatorThe example
# Parcelwire API
> Parcelwire is a REST API for creating shipping labels and tracking parcels with European carriers.
Base URL: https://api.parcelwire.example/v2. Authentication uses a secret API key in the Authorization header.
## Start here
- [Quickstart](https://docs.parcelwire.example/quickstart.md): create a label in three API calls
- [Authentication](https://docs.parcelwire.example/auth.md): API keys, test mode, key rotation
## Guides
- [Create a shipment](https://docs.parcelwire.example/guides/shipments.md): addresses, parcels, services
- [Webhooks](https://docs.parcelwire.example/guides/webhooks.md): tracking events and signature checks
- [Errors](https://docs.parcelwire.example/errors.md): error codes and retries
## Reference
- [API reference](https://docs.parcelwire.example/reference.md): every endpoint with parameters
- [SDKs](https://docs.parcelwire.example/sdks.md): Node, Python and PHP libraries
## Optional
- [Changelog](https://docs.parcelwire.example/changelog.md)
- [Full docs in one file](https://docs.parcelwire.example/llms-full.txt)
Docs-specific advice
- Markdown versions: the llms.txt proposal suggests offering a clean .md version of pages (for example page.html.md). Assistants read Markdown far more reliably than heavy HTML. Link .md URLs only if they really exist.
- Version once: if you have several API versions, link the current one and mention older versions in a sentence.
- Put critical facts in the header: base URL, authentication method and rate limits are what coding assistants get wrong most.
- Check your docs platform first: several docs platforms now generate llms.txt automatically. Review theirs before writing your own.
llms-full.txt
A single file with the full text of your docs. Useful for coding assistants that load docs into context. Keep it regenerated on every docs deploy so it never goes stale.
Questions and answers
What should a docs llms.txt include?
Quickstart, authentication, core guides, API reference and SDKs, each with a one-line description. Add base URL and auth facts at the top.
Should links point to HTML or Markdown pages?
Markdown versions if you have them; the proposal recommends them. Otherwise link the normal HTML pages.
What is llms-full.txt?
A companion file with the full text of your docs in one place. It's optional and can be large.
How do I keep llms.txt in sync with my docs?
Generate it in your docs build from the navigation, or review it on every release.
Do coding assistants actually read llms.txt?
Some AI tools and coding assistants do when pointed at a docs site. It isn't required by any major AI company.
Can I list deprecated endpoints?
Only with a clear note that they're deprecated, or leave them out so assistants don't suggest them.
Sources
Related tools and guides
llms.txt examples
All free Countnest tools · Plain-text summary for AI assistants
30-day free trial, no card required. Then from $14 a month. Cancel anytime.
Start free for 30 days