Merge pull request #7 from Capster/github-actions

Setup a documentation generator action
Capster · Oct 7, 2023 · 6776655 · 6776655
2 parents 4aa80ad + 087e5db
commit 6776655
Show file tree

Hide file tree

Showing 245 changed files with 34 additions and 145,885 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -0,0 +1,34 @@
+name: Documentation Generation
+on:
+  push:
+    branches:
+      - master
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v2
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v2
+
+      - name: Retrieve the cached "node_modules" directory (if present)
+        uses: actions/cache@v2
+        id: node-cache
+        with:
+          path: node_modules
+          key: node-modules-${{ runner.os }}-${{ hashFiles('package-lock.json') }}
+
+      - name: Install dependencies (if the cached directory was not found)
+        if: steps.node-cache.outputs.cache-hit != 'true'
+        run: npm ci
+
+      - name: Create the docs directory locally in CI
+        run: npx typedoc
+
+      - name: Deploy 🚀
+        uses: JamesIves/[email protected]
+        with:
+          branch: gh-pages
+          folder: docs
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css
diff --git a/docs/assets/main.js b/docs/assets/main.js
diff --git a/docs/assets/my-theme.css b/docs/assets/my-theme.css
diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js
diff --git a/docs/assets/search.js b/docs/assets/search.js