Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support llms.txt generation #4590

Open
4 tasks done
S1M0N38 opened this issue Mar 2, 2025 · 1 comment · May be fixed by #4635
Open
4 tasks done

Support llms.txt generation #4590

S1M0N38 opened this issue Mar 2, 2025 · 1 comment · May be fixed by #4635

Comments

@S1M0N38
Copy link

S1M0N38 commented Mar 2, 2025

Is your feature request related to a problem? Please describe.

VitePress lacks support for the emerging llms.txt "standard", which provides markdown content in a format optimized for LLM consumption. Documentation sites need a way to make their content more easily digestible by AI assistants for improved accuracy and context preservation.

Describe the solution you'd like

Implement native llms.txt generation in VitePress:

  • Auto-generate LLM-optimized versions of documentation
  • Support structured content formatting for better AI comprehension
  • Provide configuration options to customize output format

Describe alternatives you've considered

Manual content transformation or post-processing scripts, but these create maintenance overhead and version inconsistencies.

Additional context

The llms.txt standard focuses on making documentation more accessible to AI systems through optimized formatting and structure. Supporting this would enhance how VitePress documentation is consumed by AI assistants, resulting in more accurate responses when users query documentation content through LLMs.

Validations

@okineadev
Copy link
Contributor

Hello 👋

I created vitepress-plugin-llms which generates LLM-Friendly documentation

This plugin generates the following files:

.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

This plugin is still very new and under active development, not yet published, I will release the first release when I add tests (± tomorrow)

You can star the project, I would be very grateful for your support!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants