docs: migrate from Documenter.HTML to DocumenterVitepress - #814
Merged
Conversation
- docs/Project.toml: replace DocumenterMermaid with DocumenterVitepress + LiveServer
- docs/make.jl: switch format to MarkdownVitepress, remove logger filter,
remove "Introduction" from pages, switch to DocumenterVitepress.deploydocs
guarded by bases.txt, warnonly=true
- docs/src/.vitepress/config.mts: generated + patched (nav, CT assets, ignoreDeadLinks,
Vite plugin escaping {{ }} in inline code for Vue template safety)
- docs/src/.vitepress/theme/style.css: merge custom.css responsive layout helpers
- docs/src/components/: VitePress Vue components (VersionPicker, etc.)
- docs/.gitignore: exclude build/, node_modules/, package-lock.json, Manifest.toml
- docs/package.json: npm dependencies for VitePress build
- .gitignore: add !docs/package.json exception
- .github/workflows/Documentation.yml: restrict tag trigger to stable releases only
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.
Summary
Migrates the documentation system from
Documenter.HTMLtoDocumenterVitepress(VitePress-based static site generator).Changes
docs/make.jlDocumenter.HTMLtoDocumenterVitepress.MarkdownVitepressDocumenterMermaiddependency and logger filter (ExampleSizeThresholdFilter)"Introduction" => "index.md"from pages (VitePress uses it as root automatically)deploydocstoDocumenterVitepress.deploydocs, guarded bybases.txtcheckwarnonly=true(doc content will be updated in a follow-up PR)docs/Project.tomlDocumenterMermaidwithDocumenterVitepress(v0.3) andLiveServer(v1)docs/src/.vitepress/config.mts(new)DocumenterVitepress.generate_template+ patched:vitepress-documentation.cssandvitepress-documentation.jsignoreDeadLinks: true(dead links will be fixed in doc content update PR){{ }}in backtick inline code (fixes Vue template parsing error with CTFlows@Lie {{H, K}, L}syntax)docs/src/.vitepress/theme/style.css(new)custom.cssresponsive layout helpers (responsive-columns-left-priority,responsive-columns-40-60)docs/src/components/(new)VersionPicker.vue,Authors.vue,AuthorBadge.vue,SidebarDrawerToggle.vuedocs/package.json(new).gitignore!docs/package.jsonexception to track it despite*.jsonruledocs/.gitignore(new)build/,node_modules/,package-lock.json,Manifest.toml.github/workflows/Documentation.yml*tov[0-9]+\.[0-9]+\.[0-9]+(stable releases only)Verification
npm installsucceedsjulia --project=docs docs/make.jl(draft mode) builds successfullybuild complete in 8.38sdocs/build/1/Out of scope (follow-up PRs)