Chore/zensical (#2784)

* Update theme so we can switch to zensical

* Update build environment

* Add back in some customization and add new code colors for light mode

* Rework admonition coloring and tab controls nested in them

* No blur on tab controls

* Adjust tab control colors

* More style cleanup

* Update table theme

* Add tab accents back

* Docs: Update JS deps and rename mkdocs.yml to zensical.yml

* Update dev instructions to mention Zensical and not Mkdocs

* Update JS deps and tweak Mermaid diagrams

Author: facelessuser

.github/workflows/publish.yml

@@ -6,7 +6,13 @@ on:
     - '*'
   workflow_dispatch:
 
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
 jobs:
+
   documents:
     strategy:
       max-parallel: 4
@@ -15,23 +21,19 @@ jobs:
 
     runs-on: ubuntu-latest
 
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
     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 build
-        python -m pip install -r requirements/docs.txt
-    - name: Deploy documents
-      run: |
-        git config user.name ${{ secrets.GH_USER }}
-        git config user.email "${{ secrets.GH_EMAIL }}"
-        git remote add gh-token "https://${{ secrets.GH_TOKEN }}@github.com/facelessuser/pymdown-extensions.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
+      - uses: actions/configure-pages@v5
+      - uses: actions/checkout@v5
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: pip install zensical
+      - run: zensical -f zensical.yml build --clean
+      - uses: actions/upload-pages-artifact@v4
+        with:
+          path: site
+      - uses: actions/deploy-pages@v4

.pyspelling.yml

@@ -12,6 +12,11 @@ matrix:
       - '.md-social__link'
       - 'span.keys'
       - '.arithmatex, .md-nav__link, .md-footer-custom-text, .md-source__repository, .headerlink, .md-icon'
+  - pyspelling.filters.context:
+      context_visible_first: true
+      delimiters:
+      - open: '(?<=\w)''s(?!\w)'
+        close: '\b'
   - pyspelling.filters.url:
   sources:
   - site/**/*.html
@@ -44,6 +49,11 @@ matrix:
       - alt
       ignores:
       - ':matches(code, pre)'
+  - pyspelling.filters.context:
+      context_visible_first: true
+      delimiters:
+      - open: '(?<=\w)''s(?!\w)'
+        close: '\b'
   - pyspelling.filters.url:
 
 - name: javascript
@@ -63,6 +73,11 @@ matrix:
       # Ignore text between inline back ticks
       - open: '(?P<open>`+)'
         close: '(?P=open)'
+  - pyspelling.filters.context:
+      context_visible_first: true
+      delimiters:
+      - open: '(?<=\w)''s(?!\w)'
+        close: '\b'
   - pyspelling.filters.url:
   default_encoding: utf-8
   sources:
@@ -105,6 +120,11 @@ matrix:
       # Ignore text between inline back ticks
       - open: '(?P<open>`+)'
         close: '(?P=open)'
+  - pyspelling.filters.context:
+      context_visible_first: true
+      delimiters:
+      - open: '(?<=\w)''s(?!\w)'
+        close: '\b'
   - pyspelling.filters.url:
 
 - name: python
@@ -136,6 +156,11 @@ matrix:
       # Ignore Python encoding string -*- encoding stuff -*-
       - open: '^ *-\*-'
         close: '-\*-$'
+  - pyspelling.filters.context:
+      context_visible_first: true
+      delimiters:
+      - open: '(?<=\w)''s(?!\w)'
+        close: '\b'
   - pyspelling.filters.context:
       context_visible_first: true
       escapes: '\\[\\`]'

docs/src/dictionary/en-custom.txt

@@ -2,7 +2,6 @@ API
 Accessors
 Apr
 Arithmatex
-Arithmatex's
 Aspell
 AttrList
 Backoff
@@ -16,7 +15,6 @@ CVE
 Changelog
 Cloudflare
 CodeHilite
-CodeHilite's
 CodePen
 CommonMark
 CriticMarkup
@@ -31,7 +29,6 @@ ElementTree
 Emmet
 Emoji
 EmojiOne
-EmojiOne's
 Esc
 EscapeAll
 ExtraRawHTML
@@ -42,21 +39,15 @@ GFM
 GIF
 Gantt
 Gemoji
-Gemoji's
 Gendered
 GitHub
-GitHub's
 GitHubEmoji
 GitLab
-GitLab's
 Gitter
-Gruber's
 HeaderAnchor
-HeaderAnchor's
 Hunspell
 Inline
 InlineHilite
-InlineHilite's
 JPEG
 JSON
 Jan
@@ -69,7 +60,6 @@ LaTeX
 Limberg
 MERCHANTABILITY
 MagicLink
-MagicLink's
 Malus
 Mar
 MathJax
@@ -87,21 +77,20 @@ PHP
 PNG
 PNGs
 Pandoc
-Pandoc's
 Parsers
 PathConverter
-PathConverter's
 PathLike
 PlainHTML
 Pomaceous
 Postprocessor
 ProgressBar
+EmojiOne
 PyMdown
 PyPI
 PyYAML
 PyYaml
-PyYaml's
 Pygments
+Gruber
 Pymdownx
 Reindent
 Rosaceae
@@ -126,8 +115,6 @@ Tox
 Treeprocessor
 Treeprocessors
 Twemoji
-Twemoji's
-Twitter's
 UML
 UTF
 Uml
@@ -136,6 +123,7 @@ Validators
 Virtualenv
 Waylan
 YAML
+Zensical
 accessor
 backoff
 backrefs
@@ -171,15 +159,13 @@ eslint
 etree
 facelessuser
 formatter
-formatter's
 formatters
 frontmatter
 gantt
 gemoji
 gfm
 gforcada
 github
-highlighter's
 hostnames
 html
 incrementing
@@ -195,7 +181,6 @@ jQuery
 js
 kbd
 keymap
-lexer's
 linkafies
 linter
 lowercased
@@ -213,7 +198,6 @@ ned
 nl
 octocat
 online
-parser's
 parsers
 plugin
 plugins
@@ -278,7 +262,6 @@ tooltips
 tox
 uc
 un
-underscore's
 unescaping
 unicode
 unindented