llms.txt and page actions

AI tools read Markdown better than HTML. Every OrbitDocs site publishes Markdown versions of its docs, and every guide has buttons to copy it or open it in an AI chat. These are static files, so they work on any host, with or without an ai section.

llms.txtCopy Anchor Link

/llms.txt follows the llms.txt convention: an index of your docs that an AI tool reads first.

# Acme

> Guides and API reference for the Acme API.

## Guides

- [Quickstart](https://docs.acme.com/quickstart): Make your first request in five minutes.
- [Authentication](https://docs.acme.com/authentication): API keys and OAuth.

## Acme API

- [Create a booking](https://docs.acme.com/reference/travel/create-a-booking/): `POST /v1/bookings`
- [List bookings](https://docs.acme.com/reference/travel/list-bookings/): `GET /v1/bookings`

• The heading is site.title; the quote is site.description.
• Guides lists every guide with its frontmatter description.
• Each API gets a section with every operation and its method and path.

llms-full.txtCopy Anchor Link

/llms-full.txt holds the full text of the docs in one file: every guide as Markdown, then every API reference as Markdown (operations, parameters, request and response schemas). Pieces are separated by ---. Point an AI tool at it when you want it to know everything at once.

Markdown copy of each guideCopy Anchor Link

Each guide is also served as Markdown at /md/<slug>/content.md:

All of these sit under the base path when you have one.

Page actionsCopy Anchor Link

Every guide shows three buttons under its title:

Choose which ones appear with layout.pageActions:

import { defineConfig } from '@orbitdocs/next/config';

export default defineConfig({
  site: { title: 'Acme', url: 'https://docs.acme.com' },
  layout: {
    pageActions: ['copy-markdown', 'open-in-claude'],
  },
});

pageActions: [] hides them all. The default is all three.

Set site.urlCopy Anchor Link

site.url makes every link absolute: in llms.txt, in llms-full.txt headings, and in the page URL the Open in buttons send.

Private docsCopy Anchor Link

The Markdown files follow your access rules:

• Guides and operations restricted by access frontmatter, by an access.rules entry or by apis[].access are left out of llms.txt and llms-full.txt.
• A guide's Markdown copy needs the same access as the guide, whether frontmatter or a rule restricts it.
• In access.mode: 'private', every file needs sign-in, llms.txt included. Guides open to any signed-in reader stay in it; guides limited to some groups are left out.

See Access rules.

How it's builtCopy Anchor Link

The docs app has a route for each file, created by orbitdocs init. All of them are rendered at build time:

Edit or delete a route to change or drop a file.

Next stepsCopy Anchor Link