docs: add VitePress documentation site - #5
Merged
Merged
Conversation
Adds a VitePress site under docs/, mirroring the setup used in the migronaut repo: single config.mts, DefaultTheme + brand CSS variables (Cerbos-style amber), local MiniSearch, full SEO stack (JSON-LD, OG/Twitter, per-page canonical, sitemap, robots.txt, llms.txt). The README is split into 24 pages across guide/, api/ and reference/, with in-page anchors rewritten as cross-page links. README.md itself is left unchanged so the npm page does not regress. Deployed to Vercel via vercel.json; CI gains a Node 22 docs job that runs docs:build — dead links fail the build, so navigation stays valid. Mermaid diagrams render via vitepress-plugin-mermaid. Its transitive deps are direct devDependencies because the plugin hardcodes them into optimizeDeps.include and pnpm's strict linking leaves them unresolvable in docs:dev.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a VitePress site under docs/, mirroring the setup used in the
migronaut repo: single config.mts, DefaultTheme + brand CSS variables
(Cerbos-style amber), local MiniSearch, full SEO stack (JSON-LD,
OG/Twitter, per-page canonical, sitemap, robots.txt, llms.txt).
The README is split into 24 pages across guide/, api/ and reference/,
with in-page anchors rewritten as cross-page links. README.md itself is
left unchanged so the npm page does not regress.
Deployed to Vercel via vercel.json; CI gains a Node 22 docs job that
runs docs:build — dead links fail the build, so navigation stays valid.
Mermaid diagrams render via vitepress-plugin-mermaid. Its transitive
deps are direct devDependencies because the plugin hardcodes them into
optimizeDeps.include and pnpm's strict linking leaves them unresolvable
in docs:dev.