Is this plugin useful for your site? Consider sponsoring the developer to support the project's development 😺
# 📜 vitepress-plugin-llms
[](https://www.npmjs.com/package/vitepress-plugin-llms) [](https://npmjs.com/package/vitepress-plugin-llms) [](https://github.com/okineadev/vitepress-plugin-llms/actions/workflows/ci.yml) [](https://bun.sh) [](https://oxc.rs/)
[](https://github.com/sponsors/okineadev)
[🐛 Report bug](https://github.com/okineadev/vitepress-plugin-llms/issues/new?template=bug-report.yml) • [Request feature ✨](https://github.com/okineadev/vitepress-plugin-llms/issues/new?template=feature-request.yml)
## 📦 Installation
```bash
npm install vitepress-plugin-llms --save-dev
```
## 🛠️ Usage
Add the Vite plugin to your VitePress configuration (`.vitepress/config.ts`):
```ts
import { defineConfig } from 'vitepress'
import llmstxt from 'vitepress-plugin-llms'
export default defineConfig({
vite: {
plugins: [llmstxt()],
},
})
```
Now, thanks to this plugin, the LLM version of the website documentation is automatically generated
> [!NOTE]
>
> **For repositories with documentation in other languages:** Please do not use this plugin, only English documentation is enough for LLMs.
---
> [!TIP]
> You can add 
First, register a global component with buttons in `docs/.vitepress/theme/index.ts`:
```ts
import DefaultTheme from 'vitepress/theme'
import type { Theme } from 'vitepress'
import CopyOrDownloadAsMarkdownButtons from 'vitepress-plugin-llms/vitepress-components/CopyOrDownloadAsMarkdownButtons.vue'
export default {
extends: DefaultTheme,
enhanceApp({ app }) {
app.component('CopyOrDownloadAsMarkdownButtons', CopyOrDownloadAsMarkdownButtons)
},
} satisfies Theme
```
And tell VitePress to use an additional Markdown plugin that will insert them:
```ts
import { defineConfig } from 'vitepress'
import { copyOrDownloadAsMarkdownButtons } from 'vitepress-plugin-llms'
export default defineConfig({
// ...
markdown: {
config(md) {
md.use(copyOrDownloadAsMarkdownButtons)
},
},
})
```
---
### ✅ Good practices
#### 1. Use `description` in the pages frontmatter
Typically, the list of pages in llms.txt is generated like this:
```markdown
- [Tailwind v4](/docs/tailwind-v4.md)
```
As you can see, it's not very clear what's on this page and what it's for
But you can insert `description` in frontmatter in the `docs/tailwind-v4.md` file:
```markdown
---
description: How to use shadcn-vue with Tailwind v4.
---
...
```
And the link in the generated `llms.txt` will display the page description:
```markdown
- [Tailwind v4](/docs/tailwind-v4.md): How to use shadcn-vue with Tailwind v4.
```
### Plugin Configuration
> [!NOTE]
> In most cases you **don't need** any additional configuration because **everything works out of the box**, but if you do need to customize it, please see your IDE hints or see `src/types.d.ts` or 
### Extended markup for content management
#### Embedding content specifically for LLMs with `