Imported from ahandsel/ahandsel.github.io (
.github/skills/vitepress-include-lint/SKILL.md). Install upstream withnpx skills add ahandsel/ahandsel.github.io --skill vitepress-include-lint. Copyright stays with the author.
VitePress include lint
Verify that every VitePress include directive is formatted and resolved correctly.
Quick start
Run the bundled checker from the repository root:
node skills/vitepress-include-lint/scripts/check-vitepress-includes.mjs --paths contents
What to validate
For each include directive line:
- Enforce no space between
<!--and@include:. - Enforce no trailing space between the include path and
-->. - Resolve the referenced path from the source markdown file directory and verify the target file exists.
- Ignore fragment suffixes (for example
#english) when checking file existence.
Workflow
- Run the checker on requested files or directories.
- Review findings as
file:line:columnentries. - If requested, fix only the reported directives and rerun until clean.
Bundled resources
scripts/check-vitepress-includes.mjs
Checks markdown files for include formatting and path validity.
Examples:
node skills/vitepress-include-lint/scripts/check-vitepress-includes.mjs --paths contentsnode skills/vitepress-include-lint/scripts/check-vitepress-includes.mjs --paths contents/en contents/janode skills/vitepress-include-lint/scripts/check-vitepress-includes.mjs --paths contents --repo-root .
