add vitepress-plugin-llms integration #5168
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds integration for vitepress-plugin-llms to generate LLM-friendly documentation exports (llms.txt and llms-full.txt). However, there is a critical bug: the plugin is configured only in test fixtures but not in the main VitePress documentation build configuration, meaning the advertised URLs will not actually work in production.
Key Changes
- Added
vitepress-plugin-llmsdependency to generate LLM-friendly documentation formats - Created comprehensive integration tests with VitePress build verification
- Updated documentation to advertise LLM-friendly doc exports and usage guidelines
Reviewed Changes
Copilot reviewed 9 out of 10 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
test/llms-plugin.test.ts |
Integration test that builds VitePress fixture and verifies llms.txt, llms-full.txt, and per-page markdown generation |
test/fixtures/llms-docs/index.md |
Test fixture home page demonstrating <llm-only> tag usage |
test/fixtures/llms-docs/guide/getting-started.md |
Test fixture guide page with frontmatter and <llm-exclude> tag |
test/fixtures/llms-docs/guide/concepts.md |
Test fixture concepts page documenting LLM export features |
test/fixtures/llms-docs/.vitepress/config.mjs |
VitePress config for test fixture with plugin integration |
pnpm-workspace.yaml |
Added vitepress-plugin-llms@^1.9.1 to docs catalog and bumped rolldown-vite version |
pnpm-lock.yaml |
Lock file updates for new dependency and transitive dependencies |
package.json |
Added vitepress-plugin-llms to devDependencies |
README.md |
Added feature bullet advertising LLM-friendly docs via llms.txt URLs |
CONTRIBUTING.md |
Added documentation section explaining llm-only and llm-exclude tags usage |
Files not reviewed (1)
- pnpm-lock.yaml: Language not supported
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
I had to implement a filter as a crude way to deduplicate the sections in the generated |
Before submitting the PR, please make sure you do the following
fixes #123).Description
Fixes #4824
This implements the
llms.txtfeature discussed in the issue.Disclosure: GPT 5.1 Codex was used during development.
I am no expert in Vue, though I've tried to do my best to verify that the feature is correctly implemented.
Feedback is very welcome :)
Additional context