Skip to content

Commit ebe7386

Browse files
committed
try vitepress
1 parent dd2f9db commit ebe7386

6 files changed

Lines changed: 179 additions & 4 deletions

File tree

docs/Project.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
[deps]
22
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
3+
DocumenterVitepress = "4710194d-e776-4893-9690-8d956a29c365"
34
UnROOT = "3cd96dde-e98d-4713-81e9-a4a1b0235ce9"

docs/make.jl

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
using Documenter, UnROOT
2+
using DocumenterVitepress
23

34
makedocs(;
45
modules=[UnROOT],
5-
format = Documenter.HTML(
6-
prettyurls = get(ENV, "CI", nothing) == "true",
7-
assets=String[],
8-
),
6+
format=DocumenterVitepress.MarkdownVitepress(; repo="github.com/JuliaHEP/UnROOT.jl"),
97
pages=[
108
"Introduction" => "index.md",
119
"Example Usage" => "exampleusage.md",

docs/package.json

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"devDependencies": {
3+
"markdown-it": "^14.1.0",
4+
"markdown-it-mathjax3": "^4.3.2",
5+
"vitepress": "^1.1.4",
6+
"vitepress-plugin-tabs": "^0.5.0"
7+
},
8+
"scripts": {
9+
"docs:dev": "vitepress dev build/.documenter",
10+
"docs:build": "vitepress build build/.documenter",
11+
"docs:preview": "vitepress preview build/.documenter"
12+
},
13+
"dependencies": {
14+
"@shikijs/transformers": "^1.1.7",
15+
"markdown-it-footnote": "^4.0.0"
16+
}
17+
}

docs/src/assets/logo.png

18.8 KB
Loading

docs/src/assets/logo.svg

Lines changed: 138 additions & 0 deletions
Loading

docs/src/index.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,24 @@
1+
```@raw html
2+
---
3+
layout: home
4+
5+
hero:
6+
name: "UnROOT.jl"
7+
tagline: "Pure Julia I/O for .root file - TTree, RNTuple and more."
8+
image:
9+
src: /logo.png
10+
alt: UnROOT_Logo
11+
actions:
12+
- theme: brand
13+
text: "Quick Start"
14+
link: /exampleusage
15+
- theme: alt
16+
text: APIs
17+
link: /internalapis
18+
19+
---
20+
```
21+
122
## Introduction
223
Apart from the pursue of performance, we also strive to provide intuitive and compostable interface.
324
After all, "theoretically" fast doesn't mean the performance is accessible for the first-time physics

0 commit comments

Comments
 (0)