render docs on pages using vitepress

Author: jaromil

.envrc

@@ -1,2 +1,3 @@
 export PATH=./bin:$PATH
 use_mise
+use_nvm

.github/workflows/main.yml

@@ -6,9 +6,25 @@ on:
   push:
     branches:
       - main
+# Sets permissions to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: 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:
+  group: pages
+  cancel-in-progress: false
+
 jobs:
   test:
     runs-on: ubuntu-latest
+    name: Test build
+    env:
+      DEBUG: 'vitepress:*'
     steps:
       - uses: actions/checkout@v4
       - uses: jdx/mise-action@v2
@@ -22,3 +38,33 @@ jobs:
       - name: W3C VC journey
         run: |
           make
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: npm # or pnpm / yarn
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Install dependencies
+        run: npm ci # or pnpm install / yarn install / bun install
+      - name: Build with VitePress
+        run: |
+          npm run docs:build
+          ls -l src
+          ls -l .vitepress/dist
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: .vitepress/dist
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: test
+    runs-on: ubuntu-latest
+    name: Deploy
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -1,7 +1,10 @@
 # bin/slexfe
 bin/slangroom-exec
-*.json
+src/*.json
 *.orig
 *.rdf
 *.slang
-
+.vitepress/dist
+.vitepress/cache
+node_modules
+docs

.vitepress/config.mts

@@ -0,0 +1,37 @@
+import { defineConfig } from 'vitepress'
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  title: "Zencode W3C VC",
+  description: "Dyne.org W3C VC based on W3C standard and implemented using Zencode.",
+  base: "/zencode-w3c-vc/",
+  srcDir: "./src",
+  themeConfig: {
+    // https://vitepress.dev/reference/default-theme-config
+    nav: [
+      { text: 'Home', link: '/' },
+      { text: 'DIDRoom', link: 'https://didroom.com' },
+      { text: 'Credimi', link: 'https://credimi.io' },
+      { text: 'Zenroom', link: 'https://zenroom.org' },
+      { text: 'Zencode', link: 'https://dev.zenroom.org' },
+      { text: 'Slangroom', link: 'https://dyne.org/slangroom' },
+    ],
+
+    sidebar: [
+      {
+        text: 'Use in your app',
+        items: [
+          { text: 'How to embed', link: 'https://dev.zenroom.org/#/pages/how-to-embed' },
+          { text: 'Javascript', link: 'https://dev.zenroom.org/#/pages/javascript' },
+          { text: 'Python', link: 'https://dev.zenroom.org/#/pages/python' },
+          { text: 'Java', link: 'https://dev.zenroom.org/#/pages/java' }
+        ]
+      }
+    ],
+
+    socialLinks: [
+      { icon: 'linkedin', link: 'https://linkedin.com/company/forkbomb' },
+      { icon: 'github', link: 'https://github.com/dyne/zencode-w3c-vc' }
+    ]
+  }
+})

GNUmakefile

@@ -1,13 +1,19 @@
+.PHONY: docs
+
 all:
-	@rm -f src/*
+	@rm -f src/*.json src/*.slang
 	@bats/bin/bats sign*bats
 	@bats/bin/bats verify*bats
 
 check:
 	bats/bin/bats test.bats
 
 deps:
-	mise self-update
-	mise install aqua:dyne/slangroom-exec@latest
-	mise use aqua:dyne/slangroom-exec@latest
-	eval `mise env`
+	@mise self-update
+	@mise install aqua:dyne/slangroom-exec@latest
+	@mise use aqua:dyne/slangroom-exec@latest
+	@npm i
+	@eval `mise env`
+
+docs:
+	@npm run docs:build