llms.txt for Vue Sites

The llms.txt proposal gives AI assistants a concise summary of your site's content. It lists documentation for tools that choose to read it. It does not control crawler access or guarantee citations.

Jeremy Howard published the original proposal in September 2024. Unlike robots.txt, llms.txt uses Markdown and targets tools that choose to use a documentation index at inference time.

When llms.txt Matters

llms.txt offers a curated index for tools with limited context windows, even when your Vue documentation spans thousands of pages.

llms.txt is useful for:

• Documentation sites (API references, tutorials, guides)
• Open source projects
• Technical blogs with evergreen content
• Sites where AI assistants frequently reference your content

For sites without technical documentation, first decide which consumer would use the file. Maintaining an unused index adds work.

llms.txt vs robots.txt

Do not assume a crawler or assistant reads this file. Google ignores llms files for Search. Test the tools your readers use.

File Format

llms.txt uses a structured Markdown format. It only requires an H1 title; everything else is optional.

# Vue Router Documentation

> Vue Router is the official router for Vue.js. It deeply integrates with Vue.js core to make building Single Page Applications easy.

Key concepts: route matching, nested routes, navigation guards, route meta fields.

## Getting Started

- [Installation](https://router.vuejs.org/installation.html): Install Vue Router via [npm](https://npmjs.com)
- [Quick Start](https://router.vuejs.org/guide/): Basic router setup
- [Dynamic Routing](https://router.vuejs.org/guide/essentials/dynamic-matching.html): Route params and patterns

## API Reference

- [Router Instance](https://router.vuejs.org/api/interfaces/Router): push, replace, go, back, forward
- [Route Object](https://router.vuejs.org/api/interfaces/RouteLocationNormalizedLoaded): params, query, hash, matched
- [Navigation Guards](https://router.vuejs.org/guide/advanced/navigation-guards.html): beforeEach, beforeResolve, afterEach

## Optional

- [Changelog](https://github.com/vuejs/router/blob/main/CHANGELOG.md)
- [Migration from Vue 2](https://router.vuejs.org/guide/migration/)

The H1 title is the only required element, the name of your project or site. Everything else is optional:

• Blockquote: brief summary with key information for understanding the rest of the file.
• Body content: paragraphs, lists, or any Markdown except headings, giving context about the project.
• H2 sections: file lists with links to detailed documentation. Each entry is a Markdown link with an optional description:

- [Link Text](https://url): Optional description of what this page covers

• Optional section: an H2 titled "Optional" marks content that AI can skip if context is limited.

Implementation

Static File

The simplest approach: create a static file in your public directory.

public/
  llms.txt

# My Vue App

> A Vue 3 application with TypeScript and [Vite](https://vite.dev).

## Documentation

- [API Reference](https://example.com/docs/api): REST API endpoints
- [Components](https://example.com/docs/components): Vue component library
- [Getting Started](https://example.com/docs/setup): Installation and configuration

## Optional

- [Changelog](https://example.com/changelog)

Replace the illustrative example.com links with your published documentation URLs. Your file will be available at https://yoursite.com/llms.txt.

Extended Version

Some tools generate /llms-full.txt as a complete documentation export. The proposal does not require this companion file:

# My Vue App - Full Documentation

> Complete documentation including all API endpoints, components, and guides.

[Full content of your docs here, potentially thousands of lines]

AI tools can choose between the concise /llms.txt or complete /llms-full.txt based on their needs.

If you don't want to build your own generation script, the mdream llms.txt generator can create one from any URL.

Build-Time Generation

For large documentation sites, generate the file from the same page records that own your navigation. Use published URLs and escape Markdown link labels. Inspect generated output before shipping. A source filename is not always its public route.

Framework Plugins

Some documentation frameworks have community generators. Check each package's released documentation and inspect its output.

VitePress

A generator must resolve VitePress public routes and linked Markdown files correctly. Validate the output against the proposal.

Docusaurus

Apply the same checks if your documentation lives in Docusaurus. Its routes can differ from source filenames.

Testing Your llms.txt

1. Check it loads: visit https://yoursite.com/llms.txt
2. Validate format: check the required title and resolve each linked documentation URL. Absolute published URLs avoid ambiguity
3. Test with AI: paste your llms.txt into ChatGPT or Claude and ask about your docs

Use the mdream llms.txt validator to check your file for format issues, or browse the mdream llms.txt explorer to see how other projects structure theirs.

Who Uses llms.txt?

The proposal has optional discovery conventions. Link a scoped llms file with rel="describedby" when useful. For a page with a Markdown representation, use rel="alternate" with type="text/markdown". Root and subpath files can cover different scopes. Test consumer support instead of assuming adoption.

llms.txt and GEO

A documentation index can help a tool locate pages when it chooses to use the file. It does not prove search or AI visibility. Keep accurate page content, crawl access, and optional documentation indexing as separate concerns.

Using Nuxt?

For Nuxt, use the current Nuxt AI Ready llms.txt guide. Its example uses the released Nuxt AI Ready module and checks generated artifacts.

Checklist