Bootstrap a DocumenterVitepress.jl documentation site for a Julia package
何时使用: You have a Julia package and want modern Vitepress-based docs instead of default Documenter HTML.
前置条件
- Skill cloned — git clone https://github.com/JuliaGenAI/julia-agent-skills ~/.claude/skills/julia-agent-skills
- Julia ≥ 1.10 installed — juliaup default release
步骤
-
Ask the skill to scaffold docsUse documenter-vitepress skill — set up DocumenterVitepress.jl docs for MyPackage.jl.✓ 已复制→ Claude creates docs/ with Project.toml, make.jl, index.md configured for Vitepress
-
Run the local previewGive me the exact commands to preview locally.✓ 已复制→ julia --project=docs docs/make.jl + npm dev server instructions
-
Wire up CIAdd GitHub Actions to deploy to gh-pages on main.✓ 已复制→ Standard Julia doc-deploy workflow YAML
结果: A working docs site you can extend.
注意事项
- Version mismatch between DocumenterVitepress.jl and node/vitepress — Pin versions as the skill suggests; DocumenterVitepress releases move fast