vitepress-plugin-llms weekly downloads statistics

<!-- markdownlint-capture --> <!-- markdownlint-disable no-inline-html heading-start-left first-line-h1 --> <div align="center"> <b>Is this plugin useful for your site? Consider <a href="https://github.com/sponsors/okineadev">sponsoring the developer</a> to support the project's development 😺</b> <br><br> <a href="https://npmx.com/package/vitepress-plugin-llms"> <!-- https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#specifying-the-theme-an-image-is-shown-to --> <picture> <source media="(prefers-color-scheme: dark)" srcset="assets/hero-dark.png"> <source media="(prefers-color-scheme: light)" srcset="assets/hero-light.png"> <img src="assets/hero-dark.png" alt="Banner"> </picture> </a> <!-- prettier-ignore-start -->

📜 vitepress-plugin-llms

🐛 Report bug • Request feature ✨

</div> <!-- markdownlint-restore --> <!-- prettier-ignore-end -->

📦 Installation

npm install vitepress-plugin-llms --save-dev

🛠️ Usage

Add the Vite plugin to your VitePress configuration (.vitepress/config.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.

---

<!-- markdownlint-capture --> <!-- markdownlint-disable no-inline-html -->

[!TIP] You can add <kbd>📋 Copy as Markdown</kbd> and <kbd>📥 Download as Markdown</kbd> buttons for each page so that visitors can copy the page in Markdown format with just one click!

<img src="./assets/copy-as-markdown-buttons-screenshot.png" width="400" alt="Screenshot">

<!-- markdownlint-restore -->

First, register a global component with buttons in docs/.vitepress/theme/index.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:

import { defineConfig } from 'vitepress'
import { copyOrDownloadAsMarkdownButtons } from 'vitepress-plugin-llms'

export default defineConfig({
  // ...
  markdown: {
    config(md) {
      md.use(copyOrDownloadAsMarkdownButtons)
    },
  },
})

If you want to build your own UI instead of using the bundled Vue component, you can consume the shared composable directly:

import { useCopyOrDownloadAsMarkdownButtons } from 'vitepress-plugin-llms/vitepress-components'

Localizing the buttons

The bundled CopyOrDownloadAsMarkdownButtons component reads its labels from VitePress's themeConfig.llms. Add this configuration to .vitepress/config.ts after setting up the component above.

All properties are optional strings:

Property	Default value	Purpose
copyText	Copy page	Main copy button
copiedText	Copied	Confirmation after a successful copy
viewMarkdownText	View as Markdown	Dropdown item for viewing raw Markdown
openInAIText	Open in {provider}	Dropdown items for opening an AI provider

Keep the literal {provider} placeholder in openInAIText: the component replaces it with the provider name, such as ChatGPT or Claude.

For a single-language site, set themeConfig.llms at the top level. For a multilingual site, set locales.<locale>.themeConfig.llms for each language using VitePress's internationalization configuration. For example:

<!-- spell-checker:disable -->

import { defineConfig } from 'vitepress'…