Merge pull request #85 from miggi92/feat/vitepress

feat: vitepress

.github/dependabot.yml

@@ -22,11 +22,3 @@ updates:
     labels:
       - "npm"
       - "dependencies"
-  # Maintain dependencies for pip
-  - package-ecosystem: "pip"
-    directory: "/"
-    schedule:
-      interval: "weekly"
-    labels:
-      - "pip"
-      - "dependencies"

.github/workflows/deploy_doc.yml

@@ -1,27 +1,64 @@
-name: Publish
+# Sample workflow for building and deploying a VitePress site to GitHub Pages
+#
+name: Deploy VitePress site to Pages
 
 on:
-  workflow_dispatch:
+  # 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
-      - master
-    paths: 
-      - 'README.md'
-      - 'overrides/**'
-      - 'docs/**'
-      - 'mkdocs.yml'
-      - 'requirements.txt'
+    branches: [master]
+
+  # 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
+  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:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Not needed if lastUpdated is not enabled
+      - uses: pnpm/action-setup@v3 # Uncomment this if you're using pnpm
+      # - uses: oven-sh/setup-bun@v1 # Uncomment this if you're using Bun
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: pnpm # or pnpm / yarn
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Install dependencies
+        run: pnpm install # or pnpm install / yarn install / bun install
+      - name: Build with VitePress
+        run: pnpm docs:build # or pnpm docs:build / yarn docs:build / bun run docs:build
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/.vitepress/dist
+
+  # Deployment job
   deploy:
-    uses: ObsidianPublisher/actions/.github/workflows/deploy.yml@main     
-    with:
-      GENERATE_GRAPH: true 
-    secrets:
-      GH_PAT: ${{ secrets.GITHUB_TOKEN }}
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+    name: Deploy
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -6,7 +6,6 @@
 # Node artifact files
 node_modules/
 dist/
-package-lock.json
 
 # Compiled Java class files
 *.class
@@ -49,12 +48,5 @@ Thumbs.db
 *.mov
 *.wmv
 
-# exclude workspace cache
-docs/.obsidian/workspace*
-
-# Add below lines to exclude OS settings and caches
-docs/.trash/
-docs/.DS_Store
-
-# exclude generated files by mkdoc
-# docs/assets/graph.html
+# vitepress
+docs/.vitepress/cache