commit 0164b9341a16db7cac92feac15e0499a60c114d3
parent 0f9b214c49bc98a125ba6e83ed5162b881b6316e
Author: Erik Loualiche <eloualiche@users.noreply.github.com>
Date: Fri, 6 Feb 2026 09:58:21 -0600
Use DocumenterVitepress with proper configuration (#1)
* Use DocumenterVitepress with proper target configuration
- Add target = "build" to deploydocs (where Vitepress stores output)
- Match TigerFetch.jl configuration pattern
- Simplify index.md (sidebar nav is auto-generated from pages)
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
* Use DocumenterVitepress.deploydocs for proper multi-base deployment
DocumenterVitepress builds separate sites for each version/base and
requires its own deploydocs function to handle numbered build folders.
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
Diffstat:
3 files changed, 7 insertions(+), 11 deletions(-)
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -1,3 +1,4 @@
[deps]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+DocumenterVitepress = "4710194d-e776-4893-9690-8d956a29c365"
NickelEval = "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
diff --git a/docs/make.jl b/docs/make.jl
@@ -2,11 +2,11 @@
using NickelEval
using Documenter
+using DocumenterVitepress
makedocs(
- format = Documenter.HTML(
- prettyurls = get(ENV, "CI", nothing) == "true",
- canonical = "https://louloulibs.github.io/NickelEval",
+ format = MarkdownVitepress(
+ repo = "https://github.com/LouLouLibs/NickelEval",
),
repo = Remotes.GitHub("LouLouLibs", "NickelEval"),
sitename = "NickelEval.jl",
@@ -26,8 +26,10 @@ makedocs(
]
)
-deploydocs(;
+DocumenterVitepress.deploydocs(;
repo = "github.com/LouLouLibs/NickelEval",
+ target = "build",
devbranch = "main",
+ branch = "gh-pages",
push_preview = true,
)
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -61,10 +61,3 @@ nickel_to_toml("{ name = \"myapp\", version = \"1.0\" }")
- **Safe**: No side effects, pure functional
NickelEval.jl lets you leverage Nickel's power directly in your Julia workflows.
-
-## Contents
-
-```@contents
-Pages = ["man/quickstart.md", "man/typed.md", "man/export.md", "man/ffi.md", "lib/public.md"]
-Depth = 2
-```
