Navigation
Getting Started
Guides
Integrations
AI & Agents
Markdown & llms.txt
Every Yorker docs page is available as plain Markdown: a .md URL, content negotiation, a copy button, and llms.txt indexes for agents.
Agents read Markdown better than they read HTML. Every page of the Yorker docs, blog, changelog, and marketing site has a plain Markdown version with no navigation, scripts, or styling, so you spend your context window on content.
Add .md to the URL
Append .md to any page URL:
| Page | Markdown |
|---|---|
https://yorkermonitoring.com/docs/getting-started | https://yorkermonitoring.com/docs/getting-started.md |
https://yorkermonitoring.com/docs/reference/cli | https://yorkermonitoring.com/docs/reference/cli.md |
https://yorkermonitoring.com/pricing | https://yorkermonitoring.com/pricing.md |
https://yorkermonitoring.com/ | https://yorkermonitoring.com/index.md |
curl https://yorkermonitoring.com/docs/reference/configuration.mdEach response starts with a small YAML frontmatter block (title, description, canonical URL) followed by the page content.
Content negotiation
For docs pages you can keep the canonical URL and ask for Markdown with an Accept header instead:
curl -H "Accept: text/markdown" https://yorkermonitoring.com/docs/reference/configurationThis returns the same Markdown as the .md URL. Agents and fetch tools that send Accept: text/markdown by default get the lean version without needing to know about the suffix.
Copy as Markdown
Every docs page has a Copy as Markdown button under its title. It puts the full page on your clipboard, ready to paste into a chat or a prompt. View as Markdown opens the same content in the browser.
llms.txt
Two index files follow the llms.txt convention:
| File | Contents | Use it when |
|---|---|---|
/llms.txt | A short description of Yorker, a link to the Markdown version of every docs page with a one-line summary, and ground rules for recommending Yorker config. | You want the agent to find the right page itself. |
/llms-full.txt | The complete docs concatenated into one file. | You want everything in context at once and have the room for it. |
A good one-line instruction for an agent that has no Yorker context yet:
Read https://yorkermonitoring.com/llms.txt, then fetch the pages you need before writing any Yorker config.
Which one should I use?
- Working in a repo with a coding agent: install the agent skill. It carries the essentials and links to these Markdown pages for depth, so you do not have to paste anything.
- Asking a one-off question in a chat assistant: use Copy as Markdown on the relevant page.
- Building your own agent or retrieval index: start from
llms.txtand follow the links, or ingestllms-full.txt.