mdformat-zola 1.0.0__tar.gz

mdformat_zola-1.0.0/.github/FUNDING.yaml

@@ -0,0 +1,2 @@
+github: gaborbernat
+thanks_dev: u/gh/gaborbernat

mdformat_zola-1.0.0/.github/SECURITY.md

@@ -0,0 +1,9 @@
+# Security Policy
+
+## Supported Versions
+
+Only the latest released version is supported with security updates. Older versions will not receive patches.
+
+## Reporting a Vulnerability
+
+Please report security vulnerabilities via [GitHub's private vulnerability reporting](../../security/advisories/new).

mdformat_zola-1.0.0/.github/dependabot.yaml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    cooldown:
+      default-days: 7

mdformat_zola-1.0.0/.github/release.yaml

@@ -0,0 +1,5 @@
+changelog:
+  exclude:
+    authors:
+      - dependabot[bot]
+      - pre-commit-ci[bot]

mdformat_zola-1.0.0/.github/workflows/check.yaml

@@ -0,0 +1,80 @@
+name: 🧪 check
+on:
+  workflow_dispatch:
+  push:
+    branches: ["main"]
+  pull_request:
+  schedule:
+    - cron: "0 8 * * *"
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+permissions:
+  contents: read
+jobs:
+  test:
+    name: 🧪 test ${{ matrix.py }} - ${{ matrix.os }}
+    if: github.event_name != 'schedule' || github.repository_owner == 'gaborbernat'
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 40
+    strategy:
+      fail-fast: false
+      matrix:
+        py:
+          - "3.14"
+          - "3.13"
+          - "3.12"
+          - "3.11"
+        os:
+          - ubuntu-24.04
+          - macos-15
+          - windows-2025
+    steps:
+      - name: 🚀 Install uv
+        uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
+      - name: 📥 Checkout code
+        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+      - name: 📦 Install tox with tox-uv
+        run: uv tool install --managed-python --python 3.14 tox --with tox-uv
+      - name: 🐍 Setup Python for test ${{ matrix.py }}
+        run: uv python install ${{ matrix.py }}
+      - name: 🏗️ Setup test suite
+        run: tox run -vv --notest --skip-missing-interpreters false -e ${{ matrix.py }}
+      - name: 🏃 Run test suite
+        run: tox run --skip-pkg-install -e ${{ matrix.py }}
+        timeout-minutes: 20
+        env:
+          PYTEST_ADDOPTS: "-vv --durations=20"
+          CI_RUN: "yes"
+          DIFF_AGAINST: HEAD
+  check:
+    name: 🔎 check ${{ matrix.tox_env }} - ${{ matrix.os }}
+    if: github.event_name != 'schedule' || github.repository_owner == 'gaborbernat'
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        tox_env:
+          - dev
+          - type
+          - pkg_meta
+        os:
+          - ubuntu-24.04
+          - windows-2025
+    steps:
+      - name: 🚀 Install uv
+        uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
+      - name: 📦 Install tox
+        run: uv tool install --python-preference only-managed --python 3.14 tox --with tox-uv
+      - name: 📥 Checkout code
+        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+      - name: 🏗️ Setup check suite
+        run: tox run -vv --notest --skip-missing-interpreters false -e ${{ matrix.tox_env }}
+      - name: 🏃 Run check for ${{ matrix.tox_env }}
+        run: tox run --skip-pkg-install -e ${{ matrix.tox_env }}

mdformat_zola-1.0.0/.github/workflows/release.yaml

@@ -0,0 +1,48 @@
+name: Release to PyPI
+on:
+  push:
+    tags: ["*"]
+permissions:
+  contents: read
+env:
+  dists-artifact-name: python-package-distributions
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 📥 Checkout code
+        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+      - name: 🚀 Install the latest version of uv
+        uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
+        with:
+          cache-dependency-glob: "pyproject.toml"
+          enable-cache: false
+      - name: 📦 Build package
+        run: uv build --python 3.14 --python-preference only-managed --sdist --wheel . --out-dir dist
+      - name: 📤 Store the distribution packages
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
+        with:
+          name: ${{ env.dists-artifact-name }}
+          path: dist/*
+  release:
+    needs:
+      - build
+    runs-on: ubuntu-latest
+    environment:
+      name: release
+      url: https://pypi.org/project/mdformat-zola/${{ github.ref_name }}
+    permissions:
+      id-token: write
+    steps:
+      - name: 📥 Download all the dists
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8
+        with:
+          name: ${{ env.dists-artifact-name }}
+          path: dist/
+      - name: 🚀 Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b # v1.14.0
+        with:
+          attestations: true

mdformat_zola-1.0.0/.gitignore

@@ -0,0 +1,10 @@
+*.egg-info/
+*.py[cod]
+.coverage
+.pytest_cache/
+.tox/
+__pycache__/
+build/
+dist/
+htmlcov/
+src/mdformat_zola/version.py

mdformat_zola-1.0.0/.pre-commit-config.yaml

@@ -0,0 +1,57 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: file-contents-sorter
+        files: "^.gitignore$"
+      - id: check-case-conflict
+      - id: check-added-large-files
+  - repo: https://github.com/rhysd/actionlint
+    rev: "v1.7.10"
+    hooks:
+      - id: actionlint
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.4.1
+    hooks:
+      - id: codespell
+        additional_dependencies: ["tomli>=2.4.1; python_version < '3.11'"]
+  - repo: https://github.com/tox-dev/tox-toml-fmt
+    rev: "v1.6.0"
+    hooks:
+      - id: tox-toml-fmt
+  - repo: https://github.com/tox-dev/pyproject-fmt
+    rev: "v2.16.0"
+    hooks:
+      - id: pyproject-fmt
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: "v0.15.1"
+    hooks:
+      - id: ruff-format
+      - id: ruff-check
+        args: ["--fix", "--unsafe-fixes", "--exit-non-zero-on-fix"]
+  - repo: https://github.com/google/yamlfmt
+    rev: "v0.21.0"
+    hooks:
+      - id: yamlfmt
+  - repo: https://github.com/hukkin/mdformat
+    rev: "1.0.0"
+    hooks:
+      - id: mdformat
+        args: ["--wrap=120"]
+        additional_dependencies:
+          - mdformat-gfm>=1
+          - mdformat-gfm-alerts>=2
+          - mdformat-footnote>=0.1.3
+          - mdformat-front-matters>=2
+          - mdformat-deflist>=0.1.4
+        exclude: "^tests/fixtures/"
+  - repo: https://github.com/zizmorcore/zizmor-pre-commit
+    rev: v1.23.1
+    hooks:
+      - id: zizmor
+  - repo: meta
+    hooks:
+      - id: check-hooks-apply
+      - id: check-useless-excludes

mdformat_zola-1.0.0/CONTRIBUTING.md

@@ -0,0 +1,71 @@
+# Contributing to mdformat-zola
+
+Contributions are welcome and appreciated.
+
+## Development setup
+
+Clone the repository and create the development environment:
+
+```bash
+git clone https://github.com/gaborbernat/mdformat-zola.git
+cd mdformat-zola
+tox -e dev
+```
+
+This creates a `.tox/dev` virtual environment with all dependencies installed in editable mode.
+
+## Running the checks
+
+Run the tests across the supported Python versions:
+
+```bash
+tox -e 3.14,3.13,3.12,3.11
+```
+
+Format and lint (ruff, via pre-commit):
+
+```bash
+tox -e fix
+```
+
+Type check (ty):
+
+```bash
+tox -e type
+```
+
+The project keeps 100% test coverage and passes ruff and ty on every change.
+
+## How it works
+
+- `_syntax.py` holds the pure, mdformat-independent formatting: it parses shortcode calls, heading attributes, and
+  code-fence annotations, and emits their canonical form. `tests/test_syntax.py` covers it in isolation.
+- `_mdit_plugins/shortcodes.py` adds the markdown-it-py rules that turn shortcodes into tokens: an inline rule for
+  `{{ … }}` and a block rule that captures `{% … %} … {% end %}` bodies.
+- `_renderer.py` renders those tokens, formats prose-shortcode bodies as Markdown while leaving raw ones (Mermaid and
+  the like) verbatim, normalizes code-fence annotations, and post-processes heading attributes.
+- `_plugin.py` wires everything to mdformat's parser-extension interface.
+
+## Writing tests
+
+Tests format Markdown through the public API and assert on the result:
+
+```python
+from __future__ import annotations
+
+import mdformat
+
+
+def test_example() -> None:
+    assert mdformat.text('{{ youtube( id="x" ) }}\n', extensions=["zola"]) == '{{ youtube(id="x") }}\n'
+```
+
+Each test checks one behavior; parametrize near-duplicates. Drive the plugin through `mdformat.text`, and cover the pure
+helpers in `_syntax.py` through their own tests.
+
+## Pull requests
+
+1. Branch from `main`.
+1. Make the change with tests.
+1. Run `tox -e fix`, `tox -e type`, and the test environments.
+1. Commit following the Commitizen convention and open a pull request.

mdformat_zola-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Bernát Gábor
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mdformat_zola-1.0.0/PKG-INFO

@@ -0,0 +1,181 @@
+Metadata-Version: 2.4
+Name: mdformat-zola
+Version: 1.0.0
+Summary: Mdformat plugin for Zola-flavored Markdown
+Project-URL: Documentation, https://github.com/gaborbernat/mdformat-zola
+Project-URL: Homepage, https://github.com/gaborbernat/mdformat-zola
+Project-URL: Source, https://github.com/gaborbernat/mdformat-zola
+Project-URL: Tracker, https://github.com/gaborbernat/mdformat-zola/issues
+Maintainer-email: Bernát Gábor <gaborjbernat@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2026 Bernát Gábor
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Keywords: formatter,markdown,mdformat,zola
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.11
+Requires-Dist: markdown-it-py>=4.2
+Requires-Dist: mdformat-config>=0.2.1
+Requires-Dist: mdformat-deflist>=0.1.4
+Requires-Dist: mdformat-footnote>=0.1.3
+Requires-Dist: mdformat-front-matters>=2
+Requires-Dist: mdformat-gfm-alerts>=2
+Requires-Dist: mdformat-gfm>=1
+Requires-Dist: mdformat-pyproject>=0.1.1
+Requires-Dist: mdformat-ruff>=0.1.3
+Requires-Dist: mdformat-shfmt>=0.2
+Requires-Dist: mdformat-web>=0.2
+Requires-Dist: mdformat>=1
+Requires-Dist: mdit-py-plugins>=0.6.1
+Description-Content-Type: text/markdown
+
+# mdformat-zola
+
+[![PyPI](https://img.shields.io/pypi/v/mdformat-zola?style=flat-square)](https://pypi.org/project/mdformat-zola/)
+[![Supported Python versions](https://img.shields.io/pypi/pyversions/mdformat-zola.svg)](https://pypi.org/project/mdformat-zola/)
+[![check](https://github.com/gaborbernat/mdformat-zola/actions/workflows/check.yaml/badge.svg)](https://github.com/gaborbernat/mdformat-zola/actions/workflows/check.yaml)
+
+Mdformat plugin for [Zola](https://www.getzola.org)-flavored Markdown. It formats Zola content files while keeping
+shortcodes, heading anchors, and code-block annotations intact.
+
+Plain mdformat mangles Zola content. It reflows shortcode bodies (a Mermaid diagram becomes one escaped line), escapes
+the `*` in `{{/* … */}}`, and wraps long inline shortcodes mid-call. This plugin adds Zola's syntax to mdformat so those
+constructs round-trip.
+
+## Zola syntax
+
+Each construct below gets one stable form. Where Zola treats ordering as insignificant, the plugin sorts.
+
+### Shortcodes
+
+The plugin normalizes inline shortcodes `{{ name(args) }}` and their escaped form `{{/* name(args) */}}`: it collapses
+whitespace, sorts arguments by name, and settles on one quote style. It does not wrap or escape them.
+
+**Input:**
+
+```markdown
+{{  youtube( autoplay=true ,  id="dQw4w9WgXcQ" ) }}
+```
+
+**Output:**
+
+```markdown
+{{ youtube(autoplay=true, id="dQw4w9WgXcQ") }}
+```
+
+Body shortcodes `{% name(args) %} … {% end %}` (and the escaped `{%/* … */%}`) get the same treatment on their opening
+tag. A raw body such as a Mermaid diagram stays byte-for-byte:
+
+```markdown
+{% mermaid() %}
+graph TD
+  A["velodex[x]"] --> B[*]
+{% end %}
+```
+
+The body of a prose shortcode is Markdown that Zola re-renders, so the plugin formats it. By default this applies to
+`admonition`, `aside`, `callout`, `caution`, `details`, `important`, `note`, `quote`, `tip`, and `warning`; every other
+shortcode keeps its body verbatim. Point the plugin at your own set with the `markdown_shortcodes` option, on the CLI or
+in `.mdformat.toml`:
+
+```bash
+mdformat --zola-markdown-shortcodes quote,note,sidebar content/
+```
+
+```toml
+# .mdformat.toml
+[plugin.zola]
+markdown_shortcodes = ["quote", "note", "sidebar"]
+```
+
+Pass an empty value to keep every body verbatim.
+
+### Heading anchors
+
+Zola lets you pin a heading's [id and classes](https://www.getzola.org/documentation/content/linking/) with a
+`{#id .class}` suffix. The plugin puts the id first, then the classes in alphabetical order:
+
+```markdown
+## Introduction {.lead #intro}
+```
+
+Formats to:
+
+```markdown
+## Introduction {#intro .lead}
+```
+
+### Code-block annotations
+
+The plugin reorders Zola's
+[syntax-highlighting annotations](https://www.getzola.org/documentation/content/syntax-highlighting/) to a fixed
+sequence (`linenos`, `linenostart`, `hl_lines`, `hide_lines`, `name`), normalizes their whitespace, and keeps unknown
+annotations:
+
+````markdown
+```rust, hl_lines=3-4  8-9,linenos , linenostart=10
+````
+
+Formats to:
+
+````markdown
+```rust,linenos,linenostart=10,hl_lines=3-4 8-9
+````
+
+Internal links such as `[text](@/pages/about.md#anchor)` survive as ordinary links, no special handling needed.
+
+## Bundled features
+
+Installing the plugin pulls in the mdformat plugins that cover the rest of Zola's Markdown flavor (GitHub-Flavored
+Markdown with footnotes, definition lists, alerts, and TOML `+++` frontmatter), plus code formatters for fenced blocks:
+
+**Markdown syntax:**
+
+- [mdformat-gfm](https://github.com/hukkin/mdformat-gfm) - tables, strikethrough, task lists, autolinks
+- [mdformat-front-matters](https://github.com/kyleking/mdformat-front-matters) - TOML/YAML/JSON frontmatter
+- [mdformat-gfm-alerts](https://github.com/KyleKing/mdformat-gfm-alerts) - blockquote alerts (`[!NOTE]`, `[!WARNING]`)
+- [mdformat-footnote](https://github.com/executablebooks/mdformat-footnote) - footnotes
+- [mdformat-deflist](https://github.com/executablebooks/mdformat-deflist) - definition lists
+
+**Code-block formatting:**
+
+- [mdformat-ruff](https://github.com/Freed-Wu/mdformat-ruff) - Python blocks with ruff
+- [mdformat-shfmt](https://github.com/hukkin/mdformat-shfmt) - shell blocks with shfmt
+- [mdformat-config](https://github.com/hukkin/mdformat-config) - JSON, YAML, TOML blocks
+- [mdformat-web](https://github.com/hukkin/mdformat-web) - HTML, CSS, JavaScript blocks
+- [mdformat-pyproject](https://github.com/csala/mdformat-pyproject) - pyproject.toml blocks
+
+## Usage
+
+```bash
+mdformat content/
+```

mdformat_zola-1.0.0/README.md

@@ -0,0 +1,121 @@
+# mdformat-zola
+
+[![PyPI](https://img.shields.io/pypi/v/mdformat-zola?style=flat-square)](https://pypi.org/project/mdformat-zola/)
+[![Supported Python versions](https://img.shields.io/pypi/pyversions/mdformat-zola.svg)](https://pypi.org/project/mdformat-zola/)
+[![check](https://github.com/gaborbernat/mdformat-zola/actions/workflows/check.yaml/badge.svg)](https://github.com/gaborbernat/mdformat-zola/actions/workflows/check.yaml)
+
+Mdformat plugin for [Zola](https://www.getzola.org)-flavored Markdown. It formats Zola content files while keeping
+shortcodes, heading anchors, and code-block annotations intact.
+
+Plain mdformat mangles Zola content. It reflows shortcode bodies (a Mermaid diagram becomes one escaped line), escapes
+the `*` in `{{/* … */}}`, and wraps long inline shortcodes mid-call. This plugin adds Zola's syntax to mdformat so those
+constructs round-trip.
+
+## Zola syntax
+
+Each construct below gets one stable form. Where Zola treats ordering as insignificant, the plugin sorts.
+
+### Shortcodes
+
+The plugin normalizes inline shortcodes `{{ name(args) }}` and their escaped form `{{/* name(args) */}}`: it collapses
+whitespace, sorts arguments by name, and settles on one quote style. It does not wrap or escape them.
+
+**Input:**
+
+```markdown
+{{  youtube( autoplay=true ,  id="dQw4w9WgXcQ" ) }}
+```
+
+**Output:**
+
+```markdown
+{{ youtube(autoplay=true, id="dQw4w9WgXcQ") }}
+```
+
+Body shortcodes `{% name(args) %} … {% end %}` (and the escaped `{%/* … */%}`) get the same treatment on their opening
+tag. A raw body such as a Mermaid diagram stays byte-for-byte:
+
+```markdown
+{% mermaid() %}
+graph TD
+  A["velodex[x]"] --> B[*]
+{% end %}
+```
+
+The body of a prose shortcode is Markdown that Zola re-renders, so the plugin formats it. By default this applies to
+`admonition`, `aside`, `callout`, `caution`, `details`, `important`, `note`, `quote`, `tip`, and `warning`; every other
+shortcode keeps its body verbatim. Point the plugin at your own set with the `markdown_shortcodes` option, on the CLI or
+in `.mdformat.toml`:
+
+```bash
+mdformat --zola-markdown-shortcodes quote,note,sidebar content/
+```
+
+```toml
+# .mdformat.toml
+[plugin.zola]
+markdown_shortcodes = ["quote", "note", "sidebar"]
+```
+
+Pass an empty value to keep every body verbatim.
+
+### Heading anchors
+
+Zola lets you pin a heading's [id and classes](https://www.getzola.org/documentation/content/linking/) with a
+`{#id .class}` suffix. The plugin puts the id first, then the classes in alphabetical order:
+
+```markdown
+## Introduction {.lead #intro}
+```
+
+Formats to:
+
+```markdown
+## Introduction {#intro .lead}
+```
+
+### Code-block annotations
+
+The plugin reorders Zola's
+[syntax-highlighting annotations](https://www.getzola.org/documentation/content/syntax-highlighting/) to a fixed
+sequence (`linenos`, `linenostart`, `hl_lines`, `hide_lines`, `name`), normalizes their whitespace, and keeps unknown
+annotations:
+
+````markdown
+```rust, hl_lines=3-4  8-9,linenos , linenostart=10
+````
+
+Formats to:
+
+````markdown
+```rust,linenos,linenostart=10,hl_lines=3-4 8-9
+````
+
+Internal links such as `[text](@/pages/about.md#anchor)` survive as ordinary links, no special handling needed.
+
+## Bundled features
+
+Installing the plugin pulls in the mdformat plugins that cover the rest of Zola's Markdown flavor (GitHub-Flavored
+Markdown with footnotes, definition lists, alerts, and TOML `+++` frontmatter), plus code formatters for fenced blocks:
+
+**Markdown syntax:**
+
+- [mdformat-gfm](https://github.com/hukkin/mdformat-gfm) - tables, strikethrough, task lists, autolinks
+- [mdformat-front-matters](https://github.com/kyleking/mdformat-front-matters) - TOML/YAML/JSON frontmatter
+- [mdformat-gfm-alerts](https://github.com/KyleKing/mdformat-gfm-alerts) - blockquote alerts (`[!NOTE]`, `[!WARNING]`)
+- [mdformat-footnote](https://github.com/executablebooks/mdformat-footnote) - footnotes
+- [mdformat-deflist](https://github.com/executablebooks/mdformat-deflist) - definition lists
+
+**Code-block formatting:**
+
+- [mdformat-ruff](https://github.com/Freed-Wu/mdformat-ruff) - Python blocks with ruff
+- [mdformat-shfmt](https://github.com/hukkin/mdformat-shfmt) - shell blocks with shfmt
+- [mdformat-config](https://github.com/hukkin/mdformat-config) - JSON, YAML, TOML blocks
+- [mdformat-web](https://github.com/hukkin/mdformat-web) - HTML, CSS, JavaScript blocks
+- [mdformat-pyproject](https://github.com/csala/mdformat-pyproject) - pyproject.toml blocks
+
+## Usage
+
+```bash
+mdformat content/
+```