mdit-py-heading-attrs 1.0.0

markdown-it-py plugin to add ID attribute support to headings

mdit-py-heading-attrs

mdit-py-heading-attrs is a markdown-it-py plugin to add attribute support to headings. Currently, only anchors are supported.

Example

Input markdown:

## Getting Started {#getting-started}

Output HTML:

<h2 id="getting-started">Getting Started</h2>

Installation

pip install mdit-py-heading-attrs

Or with uv:

uv add mdit-py-heading-attrs

Usage

from markdown_it import MarkdownIt
from mdit_py_heading_attrs import heading_attrs_plugin

md = MarkdownIt().use(heading_attrs_plugin)

markdown = """
## Getting Started {#getting-started}
"""

html = md.render(markdown)
print(html)

Output:

<h2 id="getting-started">Getting Started</h2>

Syntax

Add an ID to any heading using {#id} syntax at the end:

## Heading {#my-id}

Supported Heading Formats

# ATX heading {#h1-id}
## ATX heading {#h2-id}
### ATX heading {#h3-id}

## ATX with closing ## {#my-id}

Setext H1 {#setext-h1}
==========

Setext H2 {#setext-h2}
----------

Escaping

Use backslash to escape braces if you want them to render literally:

## Code Example \{not-an-id\}

Renders as:

<h2>Code Example {not-an-id}</h2>

See Also

• mdit-py-plugins: collection of core plugins for markdown-it-py.
• mdit-py-figure: plugin to parse markdown paragraphs that start with an image into HTML <figure> elements.

Changelog

See CHANGELOG.md.

License

Apache-2.0