Skip to content

Commit

Permalink
Follow instructions in DocumenterVitepress.jl readme (Take 2) (Lilith…
Browse files Browse the repository at this point in the history
  • Loading branch information
LilithHafner authored Mar 4, 2024
1 parent d8e5529 commit 2514d87
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 6 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,5 @@
*.jl.mem
**/Manifest.toml
/docs/build/
/docs/node_modules/
/docs/package-lock.json
1 change: 1 addition & 0 deletions docs/Project.toml
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[deps]
Chairmarks = "0ca39b1e-fe0b-4e98-acfc-b1656634c4de"
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
DocumenterVitepress = "4710194d-e776-4893-9690-8d956a29c365"
12 changes: 6 additions & 6 deletions docs/make.jl
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
using Chairmarks
using Documenter
using DocumenterVitepress

DocMeta.setdocmeta!(Chairmarks, :DocTestSetup, :(using Chairmarks); recursive=true)

makedocs(;
authors="Lilith Orion Hafner <[email protected]> and contributors",
repo=Remotes.GitHub("LilithHafner", "Chairmarks.jl"),
sitename="Chairmarks.jl",
format=Documenter.HTML(;
prettyurls=get(ENV, "CI", "false") == "true",
canonical="https://Chairmarks.lilithhafner.com",
edit_link="main",
assets=String[],
),
format=DocumenterVitepress.MarkdownVitepress(
repo = "https://github.com/LilithHafner/Chairmarks.jl",
devbranch = "main",
devurl = "dev",
deploy_url = "chairmarks.lilithhafner.com"),
pages=[
"Home" => "index.md",
"Why use Chairmarks?" => "why.md",
Expand Down
17 changes: 17 additions & 0 deletions docs/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"devDependencies": {
"markdown-it": "^14.0.0",
"markdown-it-mathjax3": "^4.3.2",
"vitepress": "^1.0.0-rc.43",
"vitepress-plugin-tabs": "^0.5.0",
"vitest": "^1.3.0"
},
"scripts": {
"docs:dev": "vitepress dev build/.documenter",
"docs:build": "vitepress build build/.documenter",
"docs:preview": "vitepress preview build/.documenter"
},
"dependencies": {
"markdown-it-footnote": "^4.0.0"
}
}

0 comments on commit 2514d87

Please sign in to comment.