Package Exports

vitepress-plugin-llms
vitepress-plugin-llms/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (vitepress-plugin-llms) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

📜 vitepress-plugin-llms

📦 Installation

bun install vitepress-plugin-llms --dev
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()],
  },
});

Done!

Now, thanks to this plugin, the LLM version of the website documentation is automatically generated

Plugin Settings

See src/types.d.ts

Example Configuration

Here is an example of how to configure the plugin with custom settings:

import { defineConfig } from "vitepress";
import llmstxt from "vitepress-plugin-llms";

export default defineConfig({
  vite: {
    plugins: [
      llmstxt({
        generateLLMsFullTxt: false,
        ignoreFiles: ["blog/*"],
        customLLMsTxtTemplate: `# {title}\n\n{description}\n\n## Custom TOC\n\n{toc}`,
      }),
    ],
  },
});

This configuration does the following:

generateLLMsFullTxt: false: Disables the generation of the llms-full.txt file.
ignoreFiles: ["blog/*"]: Ignores all files in the blog directory.
customLLMsTxtTemplate: Uses a custom template for the llms.txt file.

🚀 Why `vitepress-plugin-llms`?

LLMs (Large Language Models) are great at processing text, but traditional documentation formats can be too heavy and cluttered. vitepress-plugin-llms generates raw Markdown documentation that LLMs can efficiently process

The file structure in .vitepress/dist folder will be as follows:

.vitepress/dist
├── ...
├── llms-full.txt            // A file where all the website documentation is compiled into one file
├── llms.txt                 // The main file for LLMs with all links to all sections of the documentation for LLMs
├── markdown-examples.html   // A human-friendly version of `markdown-examples` section in HTML format
└── markdown-examples.md     // A LLM-friendly version of `markdown-examples` section in Markdown format

✅ Key Features

⚡️ Easy integration with VitePress
🤖 An LLM-friendly version is generated for each page
📝 Outputs llms.txt with section links
📖 Outputs llms-full.txt with all content in one file

📖 llmstxt.org Standard

This plugin follows the llmstxt.org standard, which defines the best practices for LLM-friendly documentation.

❤️ Support

If you like this project, consider supporting it by starring ⭐ it on GitHub, sharing it with your friends, or buying me a coffee ☕

🤝 Contributing

You can read the instructions for contributing here - CONTRIBUTING.md