Merge pull request #44 from sbryngelson/mkdocs-readthedocs

Author: sbryngelson

.github/toc-generator.yml

@@ -0,0 +1,41 @@
+name: Deploy docs
+
+on:
+  push:
+    branches:
+      - master
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Build docs
+        run: |
+          pip install zensical
+          zensical build
+
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: site/
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/deploy.yml

@@ -0,0 +1,18 @@
+name: Markdown Lint
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  lint:
+    name: Markdown Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Run markdownlint
+        uses: DavidAnson/markdownlint-cli2-action@v19
+        with:
+          globs: "docs/**/*.md"

.github/workflows/markdown-lint.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     - name: Spell Check
       uses: crate-ci/typos@master

.github/workflows/spelling.yml

@@ -1,15 +1,11 @@
-*tags
-tags
-
-*.DS_Store
+site/
 .DS_Store
-
-**.aux
-**.fls
-**.synctex.gz
-**.log
-**.fdb_latexmk
-**.bbl
-**.blg
-**.spl
-**.out
+*.aux
+*.fdb_latexmk
+*.fls
+*.log
+*.synctex.gz
+*.bbl
+*.blg
+*.out
+*.spl

.github/workflows/update-toc.yml

@@ -0,0 +1,7 @@
+default: false
+
+# Rules that affect rendering
+MD001: true   # heading increment
+MD032: true   # blank lines around lists
+MD012: true   # no multiple blank lines
+MD009: true   # no trailing spaces

.gitignore

@@ -0,0 +1,65 @@
+:root {
+  --md-primary-fg-color: #292929;
+  --md-primary-fg-color--light: #3a3d3f;
+  --md-primary-fg-color--dark: #292929;
+  --md-accent-fg-color: #c0995e;
+  --md-accent-fg-color--transparent: #c0995e1a;
+}
+
+[data-md-color-scheme="slate"] {
+  --md-default-bg-color: #292929;
+  --md-default-bg-color--light: #2e3133;
+  --md-default-bg-color--lighter: #3a3d3f;
+  --md-default-bg-color--lightest: #454849;
+}
+
+.md-header {
+  background-color: #292929;
+  color: #fff;
+}
+
+.md-header a,
+.md-header__topic,
+.md-header__title {
+  color: #fff;
+}
+
+.md-header__topic {
+  font-weight: 700;
+}
+
+a {
+  color: #c0995e;
+}
+
+a:hover {
+  color: #d4b07a;
+}
+
+.md-nav__link--active,
+.md-nav__link:hover {
+  color: #c0995e;
+}
+
+.md-nav--secondary .md-nav__link--active {
+  color: #c0995e;
+  background-color: transparent;
+  border-left: 2px solid #c0995e;
+}
+
+.md-typeset a {
+  color: #c0995e;
+}
+
+.md-typeset a:hover {
+  color: #d4b07a;
+}
+
+.md-header__button.md-logo img {
+  height: 2.5rem;
+  width: auto;
+}
+
+.md-footer {
+  display: none;
+}