Merge pull request #8 from michaeljoseph/2021-mkdocs

Switch to mkdocs

Author: michaeljoseph

.env

@@ -0,0 +1,2 @@
+source_up
+use asdf

.envrc

@@ -0,0 +1,47 @@
+name: ✍️ Document and 🚀 Deployment
+on:
+  push:
+    branches: [ main ]
+    tags: [ "*" ]
+  pull_request:
+  workflow_dispatch:
+jobs:
+  documents:
+    name: "Build and deploy documentation"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: "3.9"
+
+      - name: Build documentation
+        run: |
+          python -m pip install --upgrade poetry 
+          poetry install
+          poetry run mkdocs build
+
+      - name: Deploy preview to Surge
+        if: github.event_name == 'pull_request'
+        env:
+          SURGE_TOKEN: ${{ secrets.SURGE_TOKEN }}
+        run: |
+          npx surge --project site \
+                    --domain michaeljoseph-preview-${{ github.event.number }}.surge.sh \
+                    --token ${{ secrets.SURGE_TOKEN }}
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        if: github.ref == 'refs/heads/main'
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./site
+
+      - name: Deploy to Surge
+        if: github.ref == 'refs/heads/main'
+        env:
+          SURGE_TOKEN: ${{ secrets.SURGE_TOKEN }}
+        run: |
+          npx surge --project site \
+                    --domain michaeljoseph.surge.sh \
+                    --token ${{ secrets.SURGE_TOKEN }}

.github/workflows/main.yml

@@ -36,6 +36,7 @@ nosetests.xml
 .pydevproject
 
 /docs/_build
+/site
 .idea
 *.iml
 .noseids

.gitignore

@@ -0,0 +1,2 @@
+python 3.9.5
+nodejs 16.4.0