docs(website): setup website

Author: jourdain

.bumpversion.cfg

@@ -0,0 +1,4 @@
+[codespell]
+skip = package-lock.json,CHANGELOG.md,**/*.js
+ignore-words-list = hist,scrip,SCRIP
+ignore-regex = name="ba"

.codespellrc

@@ -0,0 +1,57 @@
+name: Deploy VitePress site to Pages
+
+on:
+  push:
+    branches: [master]
+
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 24
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - name: Install dependencies
+        run: npm ci
+      - name: Build with VitePress
+        run: |
+          npm run build
+          touch docs/.vitepress/dist/.nojekyll
+      - name: Upload artifact
+        id: deployment
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/.vitepress/dist
+
+  # Deployment job
+  deploy:
+    needs: build
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    name: Deploy
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/website.yml

@@ -3,4 +3,7 @@ __pycache__
 build
 server.spec
 CLAUDE.md
-*.egg-info
+*.egg-info
+node_modules
+docs/.vitepress/dist
+docs/.vitepress/cache

.gitignore

@@ -8,7 +8,6 @@ repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: "v5.0.0"
     hooks:
-      - id: check-added-large-files
       - id: check-case-conflict
       - id: check-merge-conflict
       - id: check-symlinks
@@ -40,7 +39,6 @@ repos:
     rev: v2.3.0
     hooks:
       - id: codespell
-        args: ["-I", ".codespell-ignore"]
 
   - repo: https://github.com/abravalheri/validate-pyproject
     rev: "v0.23"

.pre-commit-config.yaml

@@ -0,0 +1,85 @@
+import { defineConfig } from "vitepress";
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  base: "/QuickView",
+  title: "E3SM QuickView",
+  description:
+    "How to start with the E3SM QuickView suite to look at your climate data",
+  head: [["link", { rel: "stylesheet", href: "/custom.css" }]],
+  themeConfig: {
+    // https://vitepress.dev/reference/default-theme-config
+    search: {
+      provider: "local",
+    },
+    logo: "/icon-full.png",
+    nav: [
+      { text: "Home", link: "/" },
+      { text: "NERSC", link: "/nersc/" },
+      { text: "Guides", link: "/guides/data" },
+    ],
+
+    sidebar: {
+      "/nersc/": [
+        {
+          text: "Connecting to NERSC",
+          items: [{ text: "Login", link: "/nersc/login" }],
+        },
+        {
+          text: "Perlmutter",
+          items: [
+            { text: "Introduction", link: "/nersc/perlmutter" },
+            { text: "Quick View", link: "/nersc/perlmutter-run-quickview" },
+            {
+              text: "Quick Compare",
+              link: "/nersc/perlmutter-run-quickcompare",
+            },
+          ],
+        },
+      ],
+      "/guides/": [
+        {
+          text: "Introduction",
+          items: [
+            { text: "Data Format", link: "/guides/data" },
+            { text: "Installation", link: "/guides/installation" },
+          ],
+        },
+        {
+          text: "Quick View",
+          items: [
+            { text: "Getting started", link: "/guides/quickview" },
+            { text: "Resources", link: "/guides/quickview/resources" },
+          ],
+        },
+        {
+          text: "Quick Compare",
+          items: [
+            { text: "Getting started", link: "/guides/quickcompare" },
+            { text: "Resources", link: "/guides/quickcompare/resources" },
+          ],
+        },
+        {
+          text: "Installations",
+          items: [
+            { text: "Desktop bundle", link: "/guides/installation/desktop" },
+            { text: "Conda package", link: "/guides/installation/conda" },
+          ],
+        },
+        {
+          text: "Development",
+          items: [
+            { text: "Introduction", link: "/guides/dev" },
+            { text: "Setup", link: "/guides/dev/setup" },
+            { text: "Publish to NERSC", link: "/guides/dev/nersc" },
+            { text: "Continuous Integration", link: "/guides/dev/ci" },
+          ],
+        },
+      ],
+    },
+
+    socialLinks: [
+      { icon: "github", link: "https://github.com/Kitware/QuickView" },
+    ],
+  },
+});