diff --git a/docs/Project.toml b/docs/Project.toml index 67197b15..fc209381 100644 --- 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" UnROOT = "3cd96dde-e98d-4713-81e9-a4a1b0235ce9" diff --git a/docs/make.jl b/docs/make.jl index 5b25eb48..e9bb098d 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -1,11 +1,9 @@ using Documenter, UnROOT +using DocumenterVitepress makedocs(; modules=[UnROOT], - format = Documenter.HTML( - prettyurls = get(ENV, "CI", nothing) == "true", - assets=String[], - ), + format=DocumenterVitepress.MarkdownVitepress(; repo="github.com/JuliaHEP/UnROOT.jl"), pages=[ "Introduction" => "index.md", "Example Usage" => "exampleusage.md", diff --git a/docs/package.json b/docs/package.json new file mode 100644 index 00000000..6da6d99d --- /dev/null +++ b/docs/package.json @@ -0,0 +1,17 @@ +{ + "devDependencies": { + "markdown-it": "^14.1.0", + "markdown-it-mathjax3": "^4.3.2", + "vitepress": "^1.1.4", + "vitepress-plugin-tabs": "^0.5.0" + }, + "scripts": { + "docs:dev": "vitepress dev build/.documenter", + "docs:build": "vitepress build build/.documenter", + "docs:preview": "vitepress preview build/.documenter" + }, + "dependencies": { + "@shikijs/transformers": "^1.1.7", + "markdown-it-footnote": "^4.0.0" + } +} diff --git a/docs/src/assets/logo.png b/docs/src/assets/logo.png new file mode 100644 index 00000000..23846ed5 Binary files /dev/null and b/docs/src/assets/logo.png differ diff --git a/docs/src/assets/logo.svg b/docs/src/assets/logo.svg new file mode 100644 index 00000000..fb321860 --- /dev/null +++ b/docs/src/assets/logo.svg @@ -0,0 +1,138 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/src/index.md b/docs/src/index.md index e08d76ec..328e889c 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -1,3 +1,24 @@ +```@raw html +--- +layout: home + +hero: + name: "UnROOT.jl" + tagline: "Pure Julia I/O for .root file - TTree, RNTuple and more." + image: + src: /logo.png + alt: UnROOT_Logo + actions: + - theme: brand + text: "Quick Start" + link: /exampleusage + - theme: alt + text: APIs + link: /internalapis + +--- +``` + ## Introduction Apart from the pursue of performance, we also strive to provide intuitive and compostable interface. After all, "theoretically" fast doesn't mean the performance is accessible for the first-time physics