Build vitepress documentation (#232)

Author: FriesischScott

.github/workflows/Documentation.yml

@@ -16,10 +16,9 @@ jobs:
       - uses: actions/checkout@v3
       - uses: julia-actions/setup-julia@v2
         with:
-          version: '1.10'
+          version: "1.10"
       - name: Build and deploy
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
-          GKSwstype: "100"
-        run: ./scripts/buildDocs.sh
+        run: ./scripts/buildVitePressDocs.sh

docs/.gitignore

@@ -0,0 +1,4 @@
+build/
+node_modules/
+package-lock.json
+Manifest.toml

docs/Project.toml

@@ -3,10 +3,11 @@ DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
 DisplayAs = "0b91fe84-8a4c-11e9-3e1d-67c38462b6d6"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 DocumenterCitations = "daee34ce-89f3-4625-b898-19384cb65244"
+DocumenterVitepress = "4710194d-e776-4893-9690-8d956a29c365"
 Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"
 Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
 UncertaintyQuantification = "7183a548-a887-11e9-15ce-a56ab60bad7a"
 
 [compat]
-Documenter = "1.4.1"
+Documenter = "1.7.0"
 DocumenterCitations = "1.3.3"

docs/literate/bayesianupdating/inverse-eigenvalue.jl

@@ -106,5 +106,5 @@ samples, evidence = bayesianupdating(likelihood, [λ1, λ2], tmcmc)
 scatter(samples.θ1, samples.θ2; lim=[0, 4], label="TMCMC", xlabel="θ1", ylabel="θ2")
 #md savefig("stiffness-samples.svg"); nothing # hide
 
-# ![](stiffness-samples.svg)
+# ![Resulting TMCMC](stiffness-samples.svg)
 #  A scatter plot of the resulting samples shows convergence to two distinct regions. Unlike the transitional Markov Chain Monte Carlo algorithm, the standard Metropolis-Hastings algorithm would have only identified one of the two regions.

docs/make.jl

@@ -3,6 +3,18 @@ using Documenter
 using DocumenterCitations
 using UncertaintyQuantification
 
+format = if !isempty(ARGS) && ARGS[1] == "vite"
+    using DocumenterVitepress
+
+    MarkdownVitepress(;
+        repo="https://github.com/FriesischScott/UncertaintyQuantification.jl",
+        devbranch="master",
+        devurl="dev"
+    )
+else
+    Documenter.HTML(; prettyurls=get(ENV, "CI", nothing) == "true")
+end
+
 DocMeta.setdocmeta!(
     UncertaintyQuantification,
     :DocTestSetup,
@@ -14,7 +26,7 @@ bib = CitationBibliography(joinpath(@__DIR__, "references.bib"))
 makedocs(;
     modules=[UncertaintyQuantification],
     plugins=[bib],
-    format=Documenter.HTML(; prettyurls=get(ENV, "CI", nothing) == "true"),
+    format=format,
     sitename="UncertaintyQuantification.jl",
     authors="Jasper Behrensdorf and Ander Gray",
     pages=[

docs/package.json

@@ -0,0 +1,15 @@
+{
+  "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": "^14.1.0",
+    "markdown-it-footnote": "^4.0.0",
+    "markdown-it-mathjax3": "^4.3.2",
+    "vitepress": "^1.1.4",
+    "vitepress-plugin-tabs": "^0.5.0"
+  }
+}

docs/references.bib

@@ -61,19 +61,6 @@ @article{chan2022adaptive
   publisher = {Elsevier}
 }
 
-@article{chingTransitionalMarkovChain2007,
-  title     = {Transitional {{Markov Chain Monte Carlo Method}} for {{Bayesian Model Updating}}, {{Model Class Selection}}, and {{Model Averaging}}},
-  author    = {Ching, Jianye and Chen, Yi-Chu},
-  year      = {2007},
-  journal   = {Journal of Engineering Mechanics},
-  volume    = {133},
-  number    = {7},
-  pages     = {816--832},
-  publisher = {American Society of Civil Engineers},
-  doi       = {10.1061/(ASCE)0733-9399(2007)133:7(816)}
-}
-
-
 @article{chingTransitionalMarkovChain2007,
   title     = {Transitional {{Markov Chain Monte Carlo Method}} for {{Bayesian Model Updating}}, {{Model Class Selection}}, and {{Model Averaging}}},
   author    = {Ching, Jianye and Chen, Yi-Chu},
@@ -148,19 +135,6 @@ @article{hastingsMonteCarloSampling1970
   doi     = {10.1093/biomet/57.1.97}
 }
 
-@article{hastingsMonteCarloSampling1970,
-  title   = {Monte {{Carlo}} Sampling Methods Using {{Markov}} Chains and Their Applications},
-  author  = {Hastings, W. K.},
-  year    = {1970},
-  journal = {Biometrika},
-  volume  = {57},
-  number  = {1},
-  pages   = {97--109},
-  issn    = {0006-3444},
-  doi     = {10.1093/biomet/57.1.97}
-}
-
-
 @book{joeDependenceModelingCopulas2015,
   title     = {Dependence {{Modeling}} with {{Copulas}}},
   author    = {Joe, Harry},
@@ -223,18 +197,6 @@ @article{metropolisEquationStateCalculations1953
   doi     = {10.1063/1.1699114}
 }
 
-@article{metropolisEquationStateCalculations1953,
-  title   = {Equation of {{State Calculations}} by {{Fast Computing Machines}}},
-  author  = {Metropolis, Nicholas and Rosenbluth, Arianna W. and Rosenbluth, Marshall N. and Teller, Augusta H. and Teller, Edward},
-  year    = {1953},
-  journal = {The Journal of Chemical Physics},
-  volume  = {21},
-  number  = {6},
-  pages   = {1087--1092},
-  issn    = {0021-9606},
-  doi     = {10.1063/1.1699114}
-}
-
 @incollection{nikolaidisTypesUncertaintyDesign2004,
   title     = {Types of {{Uncertainty}} in {{Design Decision Making}}},
   booktitle = {Engineering {{Design Reliability Handbook}}},
@@ -322,16 +284,6 @@ @book{raiffaAppliedStatisticalDecision1961
   pagetotal = {356}
 }
 
-@book{raiffaAppliedStatisticalDecision1961,
-  title     = {Applied {{Statistical Decision Theory}}},
-  author    = {Raiffa, Howard and Schaifer, Robert},
-  year      = {1961},
-  series    = {Studies in {{Managerial Economics}}},
-  publisher = {Division of Research, Graduate School of Business Adminitration, Harvard University},
-  location  = {Boston, MA},
-  pagetotal = {356}
-}
-
 @article{sklarFonctionsRepartitionDimensions1959,
   title    = {Fonctions de repartition a n dimensions et leurs marges},
   author   = {Sklar, M.},

docs/src/.vitepress/config.mts

@@ -0,0 +1,48 @@
+import { defineConfig } from 'vitepress'
+import { tabsMarkdownPlugin } from 'vitepress-plugin-tabs'
+import mathjax3 from "markdown-it-mathjax3";
+import footnote from "markdown-it-footnote";
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  base: 'REPLACE_ME_DOCUMENTER_VITEPRESS',// TODO: replace this in makedocs!
+  title: 'REPLACE_ME_DOCUMENTER_VITEPRESS',
+  description: 'REPLACE_ME_DOCUMENTER_VITEPRESS',
+  lastUpdated: true,
+  cleanUrls: true,
+  outDir: 'REPLACE_ME_DOCUMENTER_VITEPRESS', // This is required for MarkdownVitepress to work correctly...
+  head: [['link', { rel: 'icon', href: 'REPLACE_ME_DOCUMENTER_VITEPRESS_FAVICON' }]],
+  ignoreDeadLinks: true,
+
+  markdown: {
+    math: true,
+    config(md) {
+      md.use(tabsMarkdownPlugin),
+      md.use(mathjax3),
+      md.use(footnote)
+    },
+    theme: {
+      light: "github-light",
+      dark: "github-dark"}
+  },
+  themeConfig: {
+    outline: 'deep',
+    logo: 'REPLACE_ME_DOCUMENTER_VITEPRESS',
+    search: {
+      provider: 'local',
+      options: {
+        detailedView: true
+      }
+    },
+    nav: 'REPLACE_ME_DOCUMENTER_VITEPRESS',
+    sidebar: 'REPLACE_ME_DOCUMENTER_VITEPRESS',
+    editLink: 'REPLACE_ME_DOCUMENTER_VITEPRESS',
+    socialLinks: [
+      { icon: 'github', link: 'REPLACE_ME_DOCUMENTER_VITEPRESS' }
+    ],
+    footer: {
+      message: 'Made with <a href="https://luxdl.github.io/DocumenterVitepress.jl/dev/" target="_blank"><strong>DocumenterVitepress.jl</strong></a><br>',
+      copyright: `© Copyright ${new Date().getUTCFullYear()}.`
+    }
+  }
+})

docs/src/.vitepress/theme/index.ts

@@ -0,0 +1,19 @@
+// .vitepress/theme/index.ts
+import { h } from 'vue'
+import type { Theme } from 'vitepress'
+import DefaultTheme from 'vitepress/theme'
+
+import { enhanceAppWithTabs } from 'vitepress-plugin-tabs/client'
+import './style.css'
+
+export default {
+  extends: DefaultTheme,
+  Layout() {
+    return h(DefaultTheme.Layout, null, {
+      // https://vitepress.dev/guide/extending-default-theme#layout-slots
+    })
+  },
+  enhanceApp({ app, router, siteData }) {
+    enhanceAppWithTabs(app)
+  }
+} satisfies Theme