Update documentation using DocumenterVitepress.jl

.github/workflows/CI.yml

@@ -18,7 +18,7 @@ jobs:
       fail-fast: false
       matrix:
         version:
-          - '1.8'
+          - '1.9'
           - 'nightly'
         os:
           - ubuntu-latest

.github/workflows/Documenter.yml

@@ -1,36 +1,50 @@
-name: Documenter
+# Sample workflow for building and deploying a VitePress site to GitHub Pages
+#
+name: Deploy documentation
+
 on:
+  # Runs on pushes targeting the `main` branch. Change this to `master` if you're
+  # using the `master` branch as the default branch.
   push:
     branches:
-      - main
-    tags: '*'
+      -  main
+    tags: ['*']
   pull_request:
 
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+  actions: write
+
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
 concurrency:
-  # Skip intermediate builds: always.
-  # Cancel intermediate builds: only if it is a pull request build.
-  group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
+  group: pages
+  cancel-in-progress: false
+
 jobs:
+  # Build job
   build:
-    permissions:
-      contents: write
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: julia-actions/setup-julia@v1
-      - uses: julia-actions/cache@v1
-        with:
-          cache-registries: "false"
-      - name: Install documentation dependencies
-        run: julia --project=docs -e 'using Pkg; pkg"dev ."; Pkg.instantiate()'
-      - name: Build and deploy
+      - name: Checkout
+        uses: actions/checkout@v4
+        with: # Fetches the last commit only
+          fetch-depth: 0
+      - name: Setup Julia
+        uses: julia-actions/setup-julia@v2
+      - name: Pull Julia cache
+        uses: julia-actions/cache@v1
+      - uses: julia-actions/julia-docdeploy@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # For authentication with GitHub Actions token
           DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # For authentication with SSH deploy key
           GKSwstype: "100" # https://discourse.julialang.org/t/generation-of-documentation-fails-qt-qpa-xcb-could-not-connect-to-display/60988
           JULIA_DEBUG: "Documenter"
-          DATADEPS_ALWAYS_ACCEPT: true
-        run: |
-          julia --code-coverage=user --project=docs/ --color=yes docs/genfiles.jl
-          julia --code-coverage=user --project=docs/ --color=yes docs/make.jl
+          DATADEPS_ALWAYS_ACCEPT: true

.gitignore

@@ -10,5 +10,9 @@ docs/docs
 docs/site
 docs/build
 docs/var
+docs/node_modules/
+docs/Manifest.toml
+docs/package-lock.json
+
 deps/build.jl
 Manifest.toml

Project.toml

@@ -1,7 +1,7 @@
 name = "Tidier"
 uuid = "f0413319-3358-4bb0-8e7c-0c83523a93bd"
 authors = ["Karandeep Singh"]
-version = "1.2.1"
+version = "1.2.2"
 
 [deps]
 Reexport = "189a3867-3050-52da-a836-e630ba90ab69"
@@ -15,15 +15,14 @@ TidierVest = "969b988e-7aed-4820-b60d-bdec252047c4"
 
 [compat]
 Reexport = "0.2, 1"
-TidierData = "0.14, 1"
-TidierPlots = "0.5, 1"
+TidierData = "0.15, 1"
+TidierPlots = "0.6, 1"
 TidierCats = "0.1, 1"
 TidierDates = "0.2, 1"
 TidierStrings = "0.2, 1"
 TidierText = "0.1, 1"
 TidierVest = "0.4, 1"
-
-julia = "1.6"
+julia = "1.9"
 
 [extras]
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"

docs/Project.toml

@@ -3,7 +3,7 @@ CSV = "336ed68f-0bac-5ca0-87d4-7b16caf5d00b"
 Chain = "8be319e6-bccf-4806-a6f7-6fae938471bc"
 DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
-DocumenterMarkdown = "997ab1e6-3595-5248-9280-8efb232c3433"
+DocumenterVitepress = "4710194d-e776-4893-9690-8d956a29c365"
 Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"
 RDatasets = "ce6b1742-4840-55fa-b093-852dadbb1d8b"
 Tidier = "f0413319-3358-4bb0-8e7c-0c83523a93bd"

docs/make.jl

@@ -1,34 +1,73 @@
-using Documenter, DocumenterMarkdown
+using Documenter, DocumenterVitepress
 using Tidier, DataFrames, RDatasets
 
 DocTestMeta = quote
     using Tidier, DataFrames, Chain, Statistics
 end
+
 DocMeta.setdocmeta!(Tidier,
     :DocTestSetup,
     DocTestMeta;
-    recursive=true)
-makedocs(
-    modules=[Tidier],
-    clean=true,
-    doctest=true,
-    #format   = Documenter.HTML(prettyurls = get(ENV, "CI", nothing) == "true"),
-    sitename="Tidier.jl",
-    authors="Karandeep Singh et al.",
-    strict=[
-        :doctest,
-        :linkcheck,
-        :parse_error,
-        :example_block,
-        # Other available options are
-        # :autodocs_block, :cross_references, :docs_block, :eval_block, :example_block,
-        # :footnote, :meta_block, :missing_docs, :setup_block
-    ], checkdocs=:all, format=Markdown(), draft=false,
-    build=joinpath(@__DIR__, "docs")
+    recursive=true
 )
 
-deploydocs(; repo="https://github.com/TidierOrg/Tidier.jl", push_preview=true,
-    deps=Deps.pip("mkdocs", "pygments", "python-markdown-math", "mkdocs-material",
-        "pymdown-extensions", "mkdocstrings", "mknotebooks",
-        "pytkdocs_tweaks", "mkdocs_include_exclude_files", "jinja2", "mkdocs-video"),
-    make=() -> run(`mkdocs build`), target="site", devbranch="main")
+pgs = [
+    "Home" => "index.md",
+    "Get Started" => ["Installation" => "installation.md", "A Simple Data Analysis" => "simple-analysis.md"],
+    "API Reference" => "reference.md",
+    "Changelog" => "news.md",
+    "FAQ" => "faq.md",
+    # "Contributing" => "contributing.md",
+]
+
+fmt  = DocumenterVitepress.MarkdownVitepress(
+    repo = "https://github.com/TidierOrg/Tidier.jl",
+    devurl = "dev",
+    # deploy_url = "yourgithubusername.github.io/Tidier.jl.jl",
+)
+
+makedocs(;
+    modules = [Tidier],
+    authors = "Karandeep Singh et al.",
+    repo = "https://github.com/TidierOrg/Tidier.jl",
+    sitename = "Tidier.jl",
+    format = fmt,
+    pages= pgs,
+    warnonly = true,
+)
+
+deploydocs(;
+    repo = "https://github.com/TidierOrg/Tidier.jl",
+    target="build", # this is where Vitepress stores its output
+    branch = "gh-pages",
+    devbranch = "main",
+    push_preview = true,
+)
+
+# makedocs(
+#     modules=[Tidier],
+#     clean=true,
+#     doctest=true,
+#     #format   = Documenter.HTML(prettyurls = get(ENV, "CI", nothing) == "true"),
+#     sitename="Tidier.jl",
+#     authors="Karandeep Singh et al.",
+#     strict=[
+#         :doctest,
+#         :linkcheck,
+#         :parse_error,
+#         :example_block,
+#         # Other available options are
+#         # :autodocs_block, :cross_references, :docs_block, :eval_block, :example_block,
+#         # :footnote, :meta_block, :missing_docs, :setup_block
+#     ], 
+#     checkdocs=:all, 
+#     format=Markdown(),
+#     draft=false,
+#     build=joinpath(@__DIR__, "docs")
+# )
+
+# deploydocs(; repo="https://github.com/TidierOrg/Tidier.jl", push_preview=true,
+#     deps=Deps.pip("mkdocs", "pygments", "python-markdown-math", "mkdocs-material",
+#         "pymdown-extensions", "mkdocstrings", "mknotebooks",
+#         "pytkdocs_tweaks", "mkdocs_include_exclude_files", "jinja2", "mkdocs-video"),
+#     make=() -> run(`mkdocs build`), target="site", devbranch="main")

docs/package.json

@@ -0,0 +1,18 @@
+{
+  "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.0.0",
+    "markdown-it-footnote": "^4.0.0",
+    "markdown-it-mathjax3": "^4.3.2",
+    "vitepress-plugin-tabs": "^0.5.0",
+    "vitest": "^1.3.0"
+  },
+  "devDependencies": {
+    "vitepress": "^1.0.2"
+  }
+}