Use Zensical instead of MkDocs (#213)

Author: facelessuser

.github/workflows/build.yml

@@ -100,28 +100,54 @@ jobs:
         token: ${{ secrets.CODECOV_TOKEN }} # required
         fail_ci_if_error: false
 
-  docs_and_lint:
+  lint:
     strategy:
-      max-parallel: 2
+      max-parallel: 1
       matrix:
-        tox-env: [documents, lint]
+        python-version: ['3.13']
+
+    env:
+      TOXENV: lint
 
     runs-on: ubuntu-latest
 
     steps:
     - uses: actions/checkout@v4
-    - name: Set up Python
+    - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v5
       with:
-        python-version: '3.13'
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip setuptools tox
+    - name: Lint
+      run: |
+        python -m tox
+
+  documents:
+    strategy:
+      max-parallel: 1
+      matrix:
+        python-version: ['3.13']
+
+    env:
+      TOXENV: documents
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
     - name: Install Aspell
-      if: matrix.tox-env == 'documents'
       run: |
         sudo apt-get install aspell aspell-en
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        python -m pip install --upgrade build setuptools tox
-    - name: ${{ matrix.tox-env }}
+        python -m pip install --upgrade build tox
+    - name: Build documents
       run: |
-        python -m tox -e ${{ matrix.tox-env }}
+        python -m tox

.github/workflows/deploy.yml

@@ -6,36 +6,6 @@ on:
     - '*'
 
 jobs:
-
-  documents:
-    strategy:
-      max-parallel: 4
-      matrix:
-        python-version: [3.13]
-
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v4
-      with:
-        fetch-depth: 0
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v5
-      with:
-        python-version: ${{ matrix.python-version }}
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip setuptools build
-        python -m pip install -r requirements/docs.txt
-    - name: Deploy documents
-      run: |
-        git config user.name facelessuser
-        git config user.email "${{ secrets.GH_EMAIL }}"
-        git remote add gh-token "https://${{ secrets.GH_TOKEN }}@github.com/facelessuser/pyspelling.git"
-        git fetch gh-token && git fetch gh-token gh-pages:gh-pages
-        python -m mkdocs gh-deploy -v --clean --remote-name gh-token
-        git push gh-token gh-pages
-
   build:
     runs-on: ubuntu-latest
 

.github/workflows/publish.yml

@@ -0,0 +1,41 @@
+name: publish
+
+on:
+  push:
+    tags:
+    - '*'
+  workflow_dispatch:
+
+jobs:
+  documents:
+    strategy:
+      max-parallel: 4
+      matrix:
+        python-version: ['3.13']
+
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    steps:
+      - uses: actions/configure-pages@v5
+      - uses: actions/checkout@v5
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: |
+          python -m pip install --upgrade pip build
+          python -m pip install -r requirements/docs.txt
+      - run: |
+          python -m zensical.main build -f zensical.yml --clean
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: site
+      - uses: actions/deploy-pages@v4

.gitignore

@@ -4,6 +4,9 @@ __pycache__/
 *.py[cod]
 *$py.class
 
+manifest-css.json
+manifest-js.json
+
 # C extensions
 *.so
 

.pyspelling.yml

@@ -21,9 +21,7 @@ matrix:
       - title
       - alt
       ignores:
-      - 'code, pre'
-      - 'a:is(.magiclink-compare, .magiclink-commit, .magiclink-repository)'
-      - 'span.keys'
+      - 'code, pre, a.magiclink, span.keys, textarea, sub, sup'
       - '.MathJax_Preview, .md-nav__link, .md-footer-custom-text, .md-source__repository, .headerlink, .md-icon'
       - '.md-social__link'
   - pyspelling.filters.context:

README.md

@@ -1,5 +1,4 @@
 [![Donate via PayPal][donate-image]][donate-link]
-[![Build][github-ci-image]][github-ci-link]
 [![Coverage Status][codecov-image]][codecov-link]
 [![PyPI Version][pypi-image]][pypi-link]
 [![PyPI - Python Version][python-image]][pypi-link]
@@ -32,8 +31,6 @@ MIT
 [aspell]: http://aspell.net/
 [hunspell]: https://hunspell.github.io/
 
-[github-ci-image]: https://github.com/facelessuser/pyspelling/workflows/build/badge.svg
-[github-ci-link]: https://github.com/facelessuser/pyspelling/actions?query=workflow%3Abuild+branch%3Amaster
 [codecov-image]: https://img.shields.io/codecov/c/github/facelessuser/pyspelling/master.svg?logo=codecov&logoColor=aaaaaa&labelColor=333333
 [codecov-link]: https://codecov.io/github/facelessuser/pyspelling
 [pypi-image]: https://img.shields.io/pypi/v/pyspelling.svg?logo=pypi&logoColor=aaaaaa&labelColor=333333

docs/src/dictionary/en-custom.txt

@@ -44,6 +44,7 @@ Unescape
 Virtualenv
 XHTML
 YAML
+Zensical
 accessor
 backticks
 blockish

docs/theme/announce.html

@@ -1,5 +1,10 @@
-<a href="{{ 'about/contributing/#contributing--support' | url }}">Sponsorship</a>
+<span class="twemoji">
+{% set icon = "material/alert-decagram" %}
+{% include ".icons/" ~ icon ~ ".svg" %}
+</span>
+<a href="{{ 'about/contributing/#become-a-sponsor' | url }}">Sponsorship</a>
 is now available!
 <span class="twemoji heart-throb">
-  <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 16 16"><path fill-rule="evenodd" d="M7.655 14.916L8 14.25l.345.666a.752.752 0 01-.69 0zm0 0L8 14.25l.345.666.002-.001.006-.003.018-.01a7.643 7.643 0 00.31-.17 22.08 22.08 0 003.433-2.414C13.956 10.731 16 8.35 16 5.5 16 2.836 13.914 1 11.75 1 10.203 1 8.847 1.802 8 3.02 7.153 1.802 5.797 1 4.25 1 2.086 1 0 2.836 0 5.5c0 2.85 2.045 5.231 3.885 6.818a22.075 22.075 0 003.744 2.584l.018.01.006.003h.002z"/></svg>
+  {% set icon = "octicons/heart-fill-16" %}
+  {% include ".icons/" ~ icon ~ ".svg" %}
 </span>