mdformat-hugo
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:
{{< ref "documentation.md" >}}
{{% note %}}
Output:
{{< ref "documentation.md" >}}
{{% note %}}
Both {{< >}} (no markdown processing) and {{% %}} (markdown processed) shortcode styles are supported.
Markdown Attributes
Hugo extends standard Markdown with 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:
- IDs (
#id) come first - Classes (
.class) follow, sorted alphabetically - Key-value pairs (
key=value) come last, sorted alphabetically by key - Values containing spaces or
=are quoted:key="hello world"; otherwise unquoted:key=value
Headings:
## Introduction {.zebra .apple #intro}
Formats to:
## Introduction {#intro .apple .zebra}
Images:
{width=300 .img-fluid height=200}
Formats to:
{.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 - GFM tables, strikethrough, task lists, autolinks
- mdformat-front-matters - TOML/YAML/JSON frontmatter
- mdformat-gfm-alerts - Blockquote alerts (
[!NOTE],[!WARNING]),[!NOTE] Title) - mdformat-footnote - Pandoc-style footnotes
- mdformat-deflist - Definition lists
Code block formatting:
- mdformat-ruff - Format Python code blocks with ruff
- mdformat-shfmt - Format shell code blocks with shfmt
- mdformat-config - Format JSON, YAML, TOML code blocks
- mdformat-web - Format HTML, CSS, JavaScript code blocks
- mdformat-pyproject - Format pyproject.toml in code blocks
Usage
mdformat content/
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mdformat_hugo-0.3.0.tar.gz.
File metadata
- Download URL: mdformat_hugo-0.3.0.tar.gz
- Upload date:
- Size: 12.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
15046029ed2db20234849771e7796db9b1067c15d9cfdfbf07cb03e96eadfb05
|
|
| MD5 |
25270538eb992018b7df254f2b4e71e8
|
|
| BLAKE2b-256 |
7b56d440a630998ba48c65ef46771588f34598944933ab1a3c1b860f60040883
|
Provenance
The following attestation bundles were made for mdformat_hugo-0.3.0.tar.gz:
Publisher:
release.yaml on gaborbernat/mdformat-hugo
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
mdformat_hugo-0.3.0.tar.gz -
Subject digest:
15046029ed2db20234849771e7796db9b1067c15d9cfdfbf07cb03e96eadfb05 - Sigstore transparency entry: 2256654364
- Sigstore integration time:
-
Permalink:
gaborbernat/mdformat-hugo@ac177cfa22d2a920da282c4911279e13a8cf23c4 -
Branch / Tag:
refs/tags/0.3.0 - Owner: https://github.com/gaborbernat
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yaml@ac177cfa22d2a920da282c4911279e13a8cf23c4 -
Trigger Event:
push
-
Statement type:
File details
Details for the file mdformat_hugo-0.3.0-py3-none-any.whl.
File metadata
- Download URL: mdformat_hugo-0.3.0-py3-none-any.whl
- Upload date:
- Size: 8.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
663588755957af26b60f03853fce25c56e9f75534f84c50aae7bf3cf08a9e0f6
|
|
| MD5 |
3d8dcd8cd52d4f9512dad5d3b608e756
|
|
| BLAKE2b-256 |
50b72e77c0e91dfc62f36ae3fe4b9f06e399cae954d633e7dab23ba4221c481c
|
Provenance
The following attestation bundles were made for mdformat_hugo-0.3.0-py3-none-any.whl:
Publisher:
release.yaml on gaborbernat/mdformat-hugo
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
mdformat_hugo-0.3.0-py3-none-any.whl -
Subject digest:
663588755957af26b60f03853fce25c56e9f75534f84c50aae7bf3cf08a9e0f6 - Sigstore transparency entry: 2256654369
- Sigstore integration time:
-
Permalink:
gaborbernat/mdformat-hugo@ac177cfa22d2a920da282c4911279e13a8cf23c4 -
Branch / Tag:
refs/tags/0.3.0 - Owner: https://github.com/gaborbernat
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yaml@ac177cfa22d2a920da282c4911279e13a8cf23c4 -
Trigger Event:
push
-
Statement type:
