Skip to content

feat(vitepress): add plugin to move llms.txt files to parent directory#19

Draft
szkl wants to merge 1 commit intomainfrom
move-llmstxt
Draft

feat(vitepress): add plugin to move llms.txt files to parent directory#19
szkl wants to merge 1 commit intomainfrom
move-llmstxt

Conversation

@szkl
Copy link
Copy Markdown
Collaborator

@szkl szkl commented Mar 26, 2026

Introduced a new plugin that moves llms.txt and llms-full.txt files generated by vitepress-plugin-llms to the parent directory of the output folder. Updated the VitePress configuration to include this new plugin and adjusted the base path for the documentation output.

Summary by CodeRabbit

Release Notes

  • Chores
    • Updated documentation site configuration and base path settings for improved URL routing.
    • Enhanced the build process with better handling of documentation artifacts during deployment.
    • Added version control exclusions for generated documentation files.

Introduced a new plugin that moves llms.txt and llms-full.txt files generated by vitepress-plugin-llms to the parent directory of the output folder. Updated the VitePress configuration to include this new plugin and adjusted the base path for the documentation output.
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 26, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: c7b07793-b675-489c-81cf-fbe009958d18

📥 Commits

Reviewing files that changed from the base of the PR and between 77190c7 and c757466.

📒 Files selected for processing (3)
  • .gitignore
  • docs/.vitepress/config.ts
  • docs/.vitepress/move-llms-txt-to-outdir-parent.ts

📝 Walkthrough

Walkthrough

Adds a gitignore pattern for website LLM files, introduces a new VitePress plugin to move generated llms.txt files from build output to its parent directory, and integrates the plugin into VitePress configuration while adjusting the base path configuration.

Changes

Cohort / File(s) Summary
Gitignore Configuration
.gitignore
Added glob pattern website/llms*.txt to exclude LLM-related text files from version control.
VitePress Build Configuration
docs/.vitepress/config.ts
Added import and integration of moveLlmsTxtToOutDirParent plugin to the plugins array; updated base configuration from '/docs/' to '/docs'.
LLM File Movement Plugin
docs/.vitepress/move-llms-txt-to-outdir-parent.ts
New VitePress plugin that executes during post-build phase to move llms.txt and llms-full.txt files from the output directory to its parent, with error handling for missing files.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~15 minutes

Possibly related PRs

Poem

🐰 Files organized, paths perfected so bright,
Moving llms.txt to its rightful height,
Build-time magic, no SSR in sight,
VitePress dancing through the build night! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: adding a VitePress plugin to move llms.txt files to the parent directory, which is the primary objective of the PR.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch move-llmstxt

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@szkl szkl marked this pull request as draft March 26, 2026 17:38
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 this pull request may close these issues.

1 participant