okineadev/vitepress-plugin-llms
📜 A VitePress plugin for generating LLM-friendly documentation
What it solves
Traditional website documentation is often too heavy and cluttered for Large Language Models (LLMs) to process efficiently. This plugin converts VitePress documentation into raw, streamlined Markdown formats that are optimized for LLM consumption.
How it works
It integrates as a Vite plugin that automatically generates LLM-friendly versions of your site's pages during the build process. It follows the llmstxt.org standard to produce specific files:
llms.txt: A main index file containing links to all documentation sections.llms-full.txt: A single compiled file containing the entire website's documentation.- Individual
.mdfiles for each page.
It also provides special tags (<llm-only> and <llm-exclude>) to allow authors to include instructions specifically for AI models or hide human-centric content from the AI versions.
Who it’s for
Developers and technical writers using VitePress to host their project documentation who want to make their docs more accessible and useful for AI agents and LLMs.
Highlights
- Zero Config: Works out of the box with simple installation.
- Content Control: Use
<llm-only>to provide AI-specific instructions and<llm-exclude>to remove noise for LLMs. - Standardized: Adheres to the llmstxt.org standard.
- User-Facing Tools: Includes optional "Copy as Markdown" and "Download as Markdown" buttons for visitors.
- Broad Adoption: Used by major projects like Vite, Vue.js, and Vitest.
Related
- Project
- Project
- Project
- Project
- Project