mdformat-hugo 0.1.0__tar.gz

mdformat_hugo-0.1.0/.github/dependabot.yaml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

mdformat_hugo-0.1.0/.github/release.yaml

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

mdformat_hugo-0.1.0/.github/workflows/check.yaml

@@ -0,0 +1,76 @@
+name: 🧪 check
+on:
+  workflow_dispatch:
+  push:
+    branches: ["main"]
+  pull_request:
+  schedule:
+    - cron: "0 8 * * *"
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+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@v7
+      - name: 📥 Checkout code
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+      - 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@v7
+      - name: 📦 Install tox
+        run: uv tool install --python-preference only-managed --python 3.14 tox --with tox-uv
+      - name: 📥 Checkout code
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+      - 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_hugo-0.1.0/.github/workflows/release.yaml

@@ -0,0 +1,44 @@
+name: Release to PyPI
+on:
+  push:
+    tags: ["*"]
+env:
+  dists-artifact-name: python-package-distributions
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 📥 Checkout code
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+      - name: 🚀 Install the latest version of uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          cache-dependency-glob: "pyproject.toml"
+      - 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@v6
+        with:
+          name: ${{ env.dists-artifact-name }}
+          path: dist/*
+  release:
+    needs:
+      - build
+    runs-on: ubuntu-latest
+    environment:
+      name: release
+      url: https://pypi.org/project/mdformat-hugo/${{ github.ref_name }}
+    permissions:
+      id-token: write
+    steps:
+      - name: 📥 Download all the dists
+        uses: actions/download-artifact@v7
+        with:
+          name: ${{ env.dists-artifact-name }}
+          path: dist/
+      - name: 🚀 Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@v1.13.0
+        with:
+          attestations: true

mdformat_hugo-0.1.0/.gitignore

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

mdformat_hugo-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,49 @@
+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.2.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: local
+    hooks:
+      - id: mdformat
+        name: mdformat
+        entry: mdformat --wrap 120
+        language: python
+        types: [markdown]
+        additional_dependencies: ["."]
+  - repo: meta
+    hooks:
+      - id: check-hooks-apply
+      - id: check-useless-excludes

mdformat_hugo-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,134 @@
+# Contributing to mdformat-hugo
+
+Contributions are welcome and appreciated.
+
+## Development Setup
+
+Clone the repository:
+
+```bash
+git clone https://github.com/gaborbernat/mdformat-hugo.git
+cd mdformat-hugo
+```
+
+Create development environment:
+
+```bash
+tox -e dev
+```
+
+This creates a `.tox/dev` virtual environment with all dependencies installed in editable mode.
+
+## Running Tests
+
+Run all tests across Python versions:
+
+```bash
+tox -e 3.14,3.13,3.12,3.11
+```
+
+Run tests for a specific Python version:
+
+```bash
+tox -e 3.14
+```
+
+Run tests with coverage:
+
+```bash
+tox -e 3.14  # Coverage report shown in output
+```
+
+## Code Quality
+
+Format and lint code:
+
+```bash
+tox -e fix
+```
+
+This runs:
+
+- `ruff format` - Code formatting
+- `ruff check --fix` - Linting with auto-fixes
+
+Type check:
+
+```bash
+tox -e type
+```
+
+This runs `pyright` in strict mode.
+
+## Code Style
+
+- Use Python 3.11+ features (walrus operators, `TYPE_CHECKING` blocks)
+- Follow existing code patterns
+- All code must pass `ruff` strict linting
+- All code must pass `pyright` strict type checking
+- 100% test coverage required
+
+## Writing Tests
+
+Tests use snapshot-style testing with `textwrap.dedent`:
+
+```python
+from textwrap import dedent
+import mdformat
+
+
+def test_example() -> None:
+    start = """\
+        ## Heading {.class}
+        """
+    outcome = mdformat.text(dedent(start), extensions=["hugo"])
+    expected = """\
+        ## Heading {.class}
+        """
+    assert outcome == dedent(expected)
+```
+
+Test patterns:
+
+- One test per behavior
+- Clear test names describing what's being tested
+- Use `dedent()` at usage point, not at variable assignment
+- Test both valid input and edge cases
+
+## Pull Request Process
+
+1. Create a feature branch from `main`
+1. Make your changes
+1. Run `tox -e fix` to format and lint
+1. Run `tox -e 3.14,3.13,3.12,3.11` to verify tests pass
+1. Run `tox -e type` to verify type checking
+1. Commit with a descriptive message following Commitizen format
+1. Push and create a pull request
+
+Pull request requirements:
+
+- All tests must pass
+- 100% code coverage maintained
+- Type checking passes
+- Linting passes
+- Clear description of changes and motivation
+
+## Project Structure
+
+```
+mdformat-hugo/
+├── src/mdformat_hugo/
+│   ├── __init__.py           # Entry point with version
+│   ├── _plugin.py            # Plugin interface implementation
+│   ├── _renderer.py          # Render functions
+│   └── _mdit_plugins/        # Custom markdown-it-py plugins
+│       ├── attrs.py          # Attribute parser (placeholder)
+│       └── shortcodes.py     # Shortcode preservation
+├── tests/                    # Test files
+├── pyproject.toml           # Project configuration
+└── tox.toml                 # Tox configuration
+```
+
+## Questions
+
+For questions or discussions, open an issue on GitHub.

mdformat_hugo-0.1.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_hugo-0.1.0/PKG-INFO

@@ -0,0 +1,173 @@
+Metadata-Version: 2.4
+Name: mdformat-hugo
+Version: 0.1.0
+Summary: Mdformat plugin for Hugo-flavored Markdown
+Project-URL: Documentation, https://mdformat-hugo.readthedocs.io
+Project-URL: Homepage, https://github.com/gaborbernat/mdformat-hugo
+Project-URL: Source, https://github.com/gaborbernat/mdformat-hugo
+Project-URL: Tracker, https://github.com/gaborbernat/mdformat-hugo/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,hugo,markdown,mdformat
+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>=3
+Requires-Dist: mdformat-config>=0.1.3
+Requires-Dist: mdformat-deflist>=0.1.2
+Requires-Dist: mdformat-footnote>=0.1.1
+Requires-Dist: mdformat-front-matters>=2
+Requires-Dist: mdformat-gfm-alerts>=1
+Requires-Dist: mdformat-gfm>=1
+Requires-Dist: mdformat-pyproject>=0.0.1
+Requires-Dist: mdformat-ruff>=0.1.3
+Requires-Dist: mdformat-shfmt>=0.1
+Requires-Dist: mdformat-web>=0.1
+Requires-Dist: mdformat>=0.7.17
+Requires-Dist: mdit-py-plugins>=0.4
+Description-Content-Type: text/markdown
+
+# mdformat-hugo
+
+[![PyPI](https://img.shields.io/pypi/v/mdformat-hugo?style=flat-square)](https://pypi.org/project/mdformat-hugo/)
+[![Supported Python versions](https://img.shields.io/pypi/pyversions/mdformat-hugo.svg)](https://pypi.org/project/mdformat-hugo/)
+[![check](https://github.com/gaborbernat/mdformat-hugo/actions/workflows/check.yaml/badge.svg)](https://github.com/gaborbernat/mdformat-hugo/actions/workflows/check.yaml)
+
+Mdformat plugin for Hugo-flavored Markdown. Formats Hugo content files while preserving shortcodes and markdown
+attributes.
+
+## Features
+
+This plugin adds support for Hugo-specific markdown syntax:
+
+### Shortcode Formatting
+
+Hugo shortcodes are formatted with normalized whitespace.
+
+**Input:**
+
+```markdown
+{{<  ref   "documentation.md"  >}}
+{{%   note   %}}
+```
+
+**Output:**
+
+```markdown
+{{< ref "documentation.md" >}}
+{{% note %}}
+```
+
+Both `{{< >}}` (no markdown processing) and `{{% %}}` (markdown processed) shortcode styles are supported.
+
+### Markdown Attributes
+
+Hugo extends standard Markdown with [markdown attributes](https://gohugo.io/content-management/markdown-attributes/) --
+a syntax for attaching HTML attributes (IDs, classes, and key-value pairs) to rendered elements. Attributes are written
+in curly braces after the element they modify, e.g., `{#my-id .my-class key=value}`.
+
+This plugin normalizes attribute order and formatting:
+
+1. **IDs** (`#id`) come first
+1. **Classes** (`.class`) follow, sorted alphabetically
+1. **Key-value pairs** (`key=value`) come last, sorted alphabetically by key
+1. Values containing spaces or `=` are quoted: `key="hello world"`; otherwise unquoted: `key=value`
+
+**Headings:**
+
+```markdown
+## Introduction {.zebra .apple #intro}
+```
+
+Formats to:
+
+```markdown
+## Introduction {#intro .apple .zebra}
+```
+
+**Images:**
+
+```markdown
+![Logo](logo.png){width=300 .img-fluid height=200}
+```
+
+Formats to:
+
+```markdown
+![Logo](logo.png){.img-fluid height=200 width=300}
+```
+
+**Code blocks:**
+
+````
+```python {linenos=table .highlight #code}
+def hello():
+    print("world")
+```
+````
+
+Formats to:
+
+````
+```python {#code .highlight linenos=table}
+def hello():
+    print("world")
+```
+````
+
+### Additional Features
+
+This plugin bundles support for Hugo markdown features and code block formatting via dependencies:
+
+**Markdown syntax:**
+
+- [mdformat-gfm](https://github.com/hukkin/mdformat-gfm) - 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) - Pandoc-style footnotes
+- [mdformat-deflist](https://github.com/executablebooks/mdformat-deflist) - Definition lists
+
+**Code block formatting:**
+
+- [mdformat-ruff](https://github.com/Freed-Wu/mdformat-ruff) - Format Python code blocks with ruff
+- [mdformat-shfmt](https://github.com/hukkin/mdformat-shfmt) - Format shell code blocks with shfmt
+- [mdformat-config](https://github.com/hukkin/mdformat-config) - Format JSON, YAML, TOML code blocks
+- [mdformat-web](https://github.com/hukkin/mdformat-web) - Format HTML, CSS, JavaScript code blocks
+- [mdformat-pyproject](https://github.com/csala/mdformat-pyproject) - Format pyproject.toml in code blocks
+
+## Usage
+
+```bash
+mdformat content/
+```

mdformat_hugo-0.1.0/README.md

@@ -0,0 +1,113 @@
+# mdformat-hugo
+
+[![PyPI](https://img.shields.io/pypi/v/mdformat-hugo?style=flat-square)](https://pypi.org/project/mdformat-hugo/)
+[![Supported Python versions](https://img.shields.io/pypi/pyversions/mdformat-hugo.svg)](https://pypi.org/project/mdformat-hugo/)
+[![check](https://github.com/gaborbernat/mdformat-hugo/actions/workflows/check.yaml/badge.svg)](https://github.com/gaborbernat/mdformat-hugo/actions/workflows/check.yaml)
+
+Mdformat plugin for Hugo-flavored Markdown. Formats Hugo content files while preserving shortcodes and markdown
+attributes.
+
+## Features
+
+This plugin adds support for Hugo-specific markdown syntax:
+
+### Shortcode Formatting
+
+Hugo shortcodes are formatted with normalized whitespace.
+
+**Input:**
+
+```markdown
+{{<  ref   "documentation.md"  >}}
+{{%   note   %}}
+```
+
+**Output:**
+
+```markdown
+{{< ref "documentation.md" >}}
+{{% note %}}
+```
+
+Both `{{< >}}` (no markdown processing) and `{{% %}}` (markdown processed) shortcode styles are supported.
+
+### Markdown Attributes
+
+Hugo extends standard Markdown with [markdown attributes](https://gohugo.io/content-management/markdown-attributes/) --
+a syntax for attaching HTML attributes (IDs, classes, and key-value pairs) to rendered elements. Attributes are written
+in curly braces after the element they modify, e.g., `{#my-id .my-class key=value}`.
+
+This plugin normalizes attribute order and formatting:
+
+1. **IDs** (`#id`) come first
+1. **Classes** (`.class`) follow, sorted alphabetically
+1. **Key-value pairs** (`key=value`) come last, sorted alphabetically by key
+1. Values containing spaces or `=` are quoted: `key="hello world"`; otherwise unquoted: `key=value`
+
+**Headings:**
+
+```markdown
+## Introduction {.zebra .apple #intro}
+```
+
+Formats to:
+
+```markdown
+## Introduction {#intro .apple .zebra}
+```
+
+**Images:**
+
+```markdown
+![Logo](logo.png){width=300 .img-fluid height=200}
+```
+
+Formats to:
+
+```markdown
+![Logo](logo.png){.img-fluid height=200 width=300}
+```
+
+**Code blocks:**
+
+````
+```python {linenos=table .highlight #code}
+def hello():
+    print("world")
+```
+````
+
+Formats to:
+
+````
+```python {#code .highlight linenos=table}
+def hello():
+    print("world")
+```
+````
+
+### Additional Features
+
+This plugin bundles support for Hugo markdown features and code block formatting via dependencies:
+
+**Markdown syntax:**
+
+- [mdformat-gfm](https://github.com/hukkin/mdformat-gfm) - 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) - Pandoc-style footnotes
+- [mdformat-deflist](https://github.com/executablebooks/mdformat-deflist) - Definition lists
+
+**Code block formatting:**
+
+- [mdformat-ruff](https://github.com/Freed-Wu/mdformat-ruff) - Format Python code blocks with ruff
+- [mdformat-shfmt](https://github.com/hukkin/mdformat-shfmt) - Format shell code blocks with shfmt
+- [mdformat-config](https://github.com/hukkin/mdformat-config) - Format JSON, YAML, TOML code blocks
+- [mdformat-web](https://github.com/hukkin/mdformat-web) - Format HTML, CSS, JavaScript code blocks
+- [mdformat-pyproject](https://github.com/csala/mdformat-pyproject) - Format pyproject.toml in code blocks
+
+## Usage
+
+```bash
+mdformat content/
+```