Skip to content

Commit b33e5d9

Browse files
authored
Update docs to DocumenterVitepress 0.2 (#658)
1 parent 9edb134 commit b33e5d9

File tree

3 files changed

+16
-11
lines changed

3 files changed

+16
-11
lines changed

docs/Project.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ ZipFile = "a5390f91-8eb1-5f08-bee0-b1d1ffed6cea"
1919

2020
[compat]
2121
Documenter = "1"
22+
DocumenterVitepress = "0.2"
2223

2324
[sources]
2425
AlgebraOfGraphics = { path = ".." }

docs/make.jl

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,20 @@ using DocumenterVitepress
44
using Literate, Glob
55
using CairoMakie
66

7-
ENV["DATADEPS_ALWAYS_ACCEPT"] = true
8-
97
DocMeta.setdocmeta!(AlgebraOfGraphics, :DocTestSetup, :(using AlgebraOfGraphics); recursive=true)
108

119
cp(joinpath(@__DIR__, "..", "CHANGELOG.md"), joinpath(@__DIR__, "src", "changelog.md"), force = true)
1210

1311
makedocs(;
14-
modules=[AlgebraOfGraphics],
15-
authors="Pietro Vertechi",
16-
repo="https://github.com/MakieOrg/AlgebraOfGraphics.jl",
17-
sitename="AlgebraOfGraphics",
12+
modules = [AlgebraOfGraphics],
13+
authors = "Pietro Vertechi",
14+
repo = "https://github.com/MakieOrg/AlgebraOfGraphics.jl",
15+
sitename = "AlgebraOfGraphics",
1816
format = DocumenterVitepress.MarkdownVitepress(;
1917
repo = "https://github.com/MakieOrg/AlgebraOfGraphics.jl",
2018
deploy_url = "https://aog.makie.org",
2119
),
22-
pages=Any[
20+
pages = Any[
2321
"Home" => "index.md",
2422
"Tutorials" => [
2523
"tutorials/intro-i.md",
@@ -95,11 +93,14 @@ makedocs(;
9593
],
9694
],
9795
],
98-
warnonly=get(ENV, "CI", "false") != "true",
96+
warnonly = get(ENV, "CI", "false") != "true",
9997
pagesonly = true,
10098
)
10199

102-
deploydocs(;
103-
repo="github.com/MakieOrg/AlgebraOfGraphics.jl",
104-
push_preview=true,
100+
DocumenterVitepress.deploydocs(;
101+
repo = "github.com/MakieOrg/AlgebraOfGraphics.jl",
102+
target = joinpath(@__DIR__, "build"),
103+
branch = "gh-pages",
104+
devbranch = "master",
105+
push_preview = true,
105106
)

docs/src/.vitepress/config.mts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,9 @@ export default defineConfig({
5454
],
5555
ignoreDeadLinks: false,
5656
vite: {
57+
define: {
58+
__DEPLOY_ABSPATH__: JSON.stringify('REPLACE_ME_DOCUMENTER_VITEPRESS_DEPLOY_ABSPATH'),
59+
},
5760
optimizeDeps: {
5861
exclude: [
5962
'@nolebase/vitepress-plugin-enhanced-readabilities/client',

0 commit comments

Comments
 (0)