(docs) Initial empty version

Author: protocolstardust

.github/workflows/deploy-pages.yml

@@ -1,55 +1,70 @@
-# GitHub Actions workflow to deploy the website to GitHub Pages
-
-name: Deploy to GitHub Pages
+name: Documentation
 
 on:
-  # Runs on pushes targeting the default branch
   push:
     branches: ["master"]
     paths:
       - 'docs/**'
       - '.github/workflows/deploy-pages.yml'
-
-  # 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: 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:
+  docs:
     runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Setup Pages
-        uses: actions/configure-pages@v4
-
-      - name: Upload artifact
-        uses: actions/upload-pages-artifact@v3
-        with:
-          # Upload the docs folder
-          path: './docs'
-
-  # Deployment job
-  deploy:
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
-    runs-on: ubuntu-latest
-    needs: build
+
     steps:
-      - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/deploy-pages@v4
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 2
+
+    - name: Setup Python
+      if: steps.check-docs.outputs.has_changes == 'true'
+      uses: actions/setup-python@v4
+      with:
+        python-version: 3.x
+
+    - name: Install MkDocs
+      if: steps.check-docs.outputs.has_changes == 'true'
+      run: |
+        pip install mkdocs-material
+        pip install mkdocs-git-revision-date-plugin
+
+    - name: Build documentation
+      if: steps.check-docs.outputs.has_changes == 'true'
+      run: |
+        cd docs
+        mkdocs build
+        cd ..
+        mv docs/site .
+        cp docs/.nojekyll site/
+        cp docs/CNAME site/CNAME
+
+    - name: Setup Pages
+      if: steps.check-docs.outputs.has_changes == 'true'
+      uses: actions/configure-pages@v4
+      with:
+        enablement: true
+        token: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Upload artifact
+      if: steps.check-docs.outputs.has_changes == 'true'
+      uses: actions/upload-pages-artifact@v3
+      with:
+        path: ./site
+
+    - name: Deploy to GitHub Pages
+      if: steps.check-docs.outputs.has_changes == 'true'
+      id: deployment
+      uses: actions/deploy-pages@v4
+      with:
+        token: ${{ secrets.GITHUB_TOKEN }}
+        branch: gh-pages
+        folder: site

.gitignore

@@ -6,3 +6,5 @@ out/
 .rayhist.dat
 test.rfl
 test.rf
+
+docs/site/

docs/CNAME

@@ -0,0 +1 @@
+vscode.rayforcedb.com