Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .spell-dict
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ prepended
preprocessor
preprocessors
Pygments
PyMdown
PyPI
PyPy
PYTHONPATH
Expand Down
1 change: 1 addition & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ See the [Contributing Guide](contributing.md) for details.
### Fixed

* Fix `SetextHeaderProcessor` regex to prevent mixed `=` and `-` chars in setext-style headers (#1606).
* Officially document all included extensions as being in maintenance mode.

## [3.10.2] - 2026-02-09

Expand Down
13 changes: 13 additions & 0 deletions docs/extensions/abbreviations.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,19 @@ Specifically, any defined abbreviation is wrapped in an `<abbr>` tag.

The Abbreviations extension is included in the standard Markdown library.

!!! Note

This extension is in __maintenance mode__. We will continue to fix bugs
and keep it up-to-date with the core parser, but no new features or
changes in behavior will be made. If you need a feature that this
extension does not offer, then you have three options (1) find an
existing [third-party extension] which meets your needs, (2) [build your
own extension], or (3) fork this extension (pursuant to its licensing
requirements) and maintain it as a third-party extension.

[third-party extension]: index.md#third-party-extensions
[build your own extension]: api.md

Syntax
------

Expand Down
16 changes: 16 additions & 0 deletions docs/extensions/admonition.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,22 @@ This extension is included in the standard Markdown library.

[rST]: http://docutils.sourceforge.net/docs/ref/rst/directives.html#specific-admonitions

!!! Note

This extension is in __maintenance mode__. We will continue to fix bugs
and keep it up-to-date with the core parser, but no new features or
changes in behavior will be made. If you need a feature that this
extension does not offer, then you have three options (1) find an
existing [third-party extension] which meets your needs, (2) [build your
own extension], or (3) fork this extension (pursuant to its licensing
requirements) and maintain it as a third-party extension.

We recommend [PyMdown Admonition] as an actively developed alternative.

[third-party extension]: index.md#third-party-extensions
[build your own extension]: api.md
[PyMdown Admonition]: https://facelessuser.github.io/pymdown-extensions/extensions/blocks/plugins/admonition/

Syntax
------

Expand Down
13 changes: 13 additions & 0 deletions docs/extensions/attr_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,19 @@ HTML elements in markdown's output.

This extension is included in the standard Markdown library.

!!! Note

This extension is in __maintenance mode__. We will continue to fix bugs
and keep it up-to-date with the core parser, but no new features or
changes in behavior will be made. If you need a feature that this
extension does not offer, then you have three options (1) find an
existing [third-party extension] which meets your needs, (2) [build your
own extension], or (3) fork this extension (pursuant to its licensing
requirements) and maintain it as a third-party extension.

[third-party extension]: index.md#third-party-extensions
[build your own extension]: api.md

## Syntax

The basic syntax was inspired by Maruku's Attribute Lists feature (see [web archive][Maruku]).
Expand Down
16 changes: 16 additions & 0 deletions docs/extensions/code_hilite.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,22 @@ Python-Markdown code blocks using [Pygments][].

This extension is included in the standard Markdown library.

!!! Note

This extension is in __maintenance mode__. We will continue to fix bugs
and keep it up-to-date with the core parser, but no new features or
changes in behavior will be made. If you need a feature that this
extension does not offer, then you have three options (1) find an
existing [third-party extension] which meets your needs, (2) [build your
own extension], or (3) fork this extension (pursuant to its licensing
requirements) and maintain it as a third-party extension.

We recommend [Highlight] as an actively developed alternative.

[third-party extension]: index.md#third-party-extensions
[build your own extension]: api.md
[Highlight]: https://facelessuser.github.io/pymdown-extensions/extensions/highlight/

## Setup

### Step 1: Download and Install Pygments
Expand Down
16 changes: 16 additions & 0 deletions docs/extensions/definition_lists.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,22 @@ Markdown documents.

This extension is included in the standard Markdown library.

!!! Note

This extension is in __maintenance mode__. We will continue to fix bugs
and keep it up-to-date with the core parser, but no new features or
changes in behavior will be made. If you need a feature that this
extension does not offer, then you have three options (1) find an
existing [third-party extension] which meets your needs, (2) [build your
own extension], or (3) fork this extension (pursuant to its licensing
requirements) and maintain it as a third-party extension.

We recommend [PyMdown Definition] as an actively developed alternative.

[third-party extension]: index.md#third-party-extensions
[build your own extension]: api.md
[PyMdown Definition]: https://facelessuser.github.io/pymdown-extensions/extensions/blocks/plugins/definition/

Syntax
------

Expand Down
13 changes: 13 additions & 0 deletions docs/extensions/extra.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,19 @@ The supported extensions include:
See each individual extension for syntax documentation. Extra and all its
supported extensions are included in the standard Markdown library.

!!! Note

This extension is in __maintenance mode__. We will continue to fix bugs
and keep it up-to-date with the core parser, but no new features or
changes in behavior will be made. If you need a feature that this
extension does not offer, then you have three options (1) find an
existing [third-party extension] which meets your needs, (2) [build your
own extension], or (3) fork this extension (pursuant to its licensing
requirements) and maintain it as a third-party extension.

[third-party extension]: index.md#third-party-extensions
[build your own extension]: api.md

## Usage

From the Python interpreter:
Expand Down
15 changes: 15 additions & 0 deletions docs/extensions/fenced_code_blocks.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,21 @@ indented code blocks.

This extension is included in the standard Markdown library.

!!! Note

This extension is in __maintenance mode__. We will continue to fix bugs
and keep it up-to-date with the core parser, but no new features or
changes in behavior will be made. If you need a feature that this
extension does not offer, then you have three options (1) find an
existing [third-party extension] which meets your needs, (2) [build your
own extension], or (3) fork this extension (pursuant to its licensing
requirements) and maintain it as a third-party extension.

We recommend [SuperFences] as an actively developed alternative.

[third-party extension]: index.md#third-party-extensions
[build your own extension]: api.md

## Syntax

Fenced Code Blocks are defined using the syntax originally established in [PHP Markdown Extra][php] and popularized by
Expand Down
13 changes: 13 additions & 0 deletions docs/extensions/footnotes.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,19 @@ documents.

This extension is included in the standard Markdown library.

!!! Note

This extension is in __maintenance mode__. We will continue to fix bugs
and keep it up-to-date with the core parser, but no new features or
changes in behavior will be made. If you need a feature that this
extension does not offer, then you have three options (1) find an
existing [third-party extension] which meets your needs, (2) [build your
own extension], or (3) fork this extension (pursuant to its licensing
requirements) and maintain it as a third-party extension.

[third-party extension]: index.md#third-party-extensions
[build your own extension]: api.md

Syntax
------

Expand Down
24 changes: 20 additions & 4 deletions docs/extensions/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,12 @@ See the [Command Line docs](../cli.md) or use the `--help` option for more detai
If you would like to write your own extensions, see the
[Extension API](api.md) for details.

Officially Supported Extensions
-------------------------------
Included Extensions
-------------------

The extensions listed below are included with (at least) the most recent release
and are officially supported by Python-Markdown. Any documentation is
maintained here and all bug reports should be made to the project. If you
maintained here and all bug reports should be made to this project. If you
have a typical install of Python-Markdown, these extensions are already
available to you using the "Entry Point" name listed in the second column below.

Expand Down Expand Up @@ -75,7 +75,23 @@ Extension | Entry Point | Dot Notation
[Table of Contents]: toc.md
[WikiLinks]: wikilinks.md

Third Party Extensions
!!! Note

All of the included extensions are in __maintenance mode__. We will
continue to fix bugs and keep them up-to-date with the core parser, but
no new features or changes in behavior will be made. Additionally, no new
extensions will be added to the project. All future extension development
should happen in third-party extensions. If you need a feature that seems
like it would be a good addition to one of the included extensions, then
you have three options (1) find an existing [third-party extension] which
meets your needs, (2) [build your own extension], or (3) fork the
relevant included extension (pursuant to its licensing requirements) and
maintain it as a third-party extension.

[third-party extension]: #third-party-extensions
[build your own extension]: api.md

Third-Party Extensions
----------------------

Various individuals and/or organizations have developed extensions which they
Expand Down
13 changes: 13 additions & 0 deletions docs/extensions/legacy_attrs.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,19 @@ users have never made use of the syntax and it has been deprecated in favor of
[Attribute Lists](attr_list.md). This extension restores the legacy behavior for
users who have existing documents which use the syntax.

!!! Note

This extension is in __maintenance mode__. We will continue to fix bugs
and keep it up-to-date with the core parser, but no new features or
changes in behavior will be made. If you need a feature that this
extension does not offer, then you have three options (1) find an
existing [third-party extension] which meets your needs, (2) [build your
own extension], or (3) fork this extension (pursuant to its licensing
requirements) and maintain it as a third-party extension.

[third-party extension]: index.md#third-party-extensions
[build your own extension]: api.md

## Syntax

Attributes are defined by including the following within the element you wish to
Expand Down
13 changes: 13 additions & 0 deletions docs/extensions/legacy_em.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,19 @@ of the reference implementation. Therefore, this extension can be used to better
match the reference implementation. With the extension enabled, the above input
would result in this output: `<em>connected</em>words_`.

!!! Note

This extension is in __maintenance mode__. We will continue to fix bugs
and keep it up-to-date with the core parser, but no new features or
changes in behavior will be made. If you need a feature that this
extension does not offer, then you have three options (1) find an
existing [third-party extension] which meets your needs, (2) [build your
own extension], or (3) fork this extension (pursuant to its licensing
requirements) and maintain it as a third-party extension.

[third-party extension]: index.md#third-party-extensions
[build your own extension]: api.md

## Usage

See [Extensions](index.md) for general extension usage. Use `legacy_em` as the
Expand Down
16 changes: 16 additions & 0 deletions docs/extensions/md_in_html.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,22 @@ title: Markdown in HTML Extension

An extension that parses Markdown inside of HTML tags.

!!! Note

This extension is in __maintenance mode__. We will continue to fix bugs
and keep it up-to-date with the core parser, but no new features or
changes in behavior will be made. If you need a feature that this
extension does not offer, then you have three options (1) find an
existing [third-party extension] which meets your needs, (2) [build your
own extension], or (3) fork this extension (pursuant to its licensing
requirements) and maintain it as a third-party extension.

We recommend [PyMdown HTML] as an alternative solution.

[third-party extension]: index.md#third-party-extensions
[build your own extension]: api.md
[PyMdown HTML]: https://facelessuser.github.io/pymdown-extensions/extensions/blocks/plugins/html/

## Syntax

By default, Markdown ignores any content within a raw HTML block-level element. With the `md-in-html` extension
Expand Down
13 changes: 13 additions & 0 deletions docs/extensions/meta_data.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,19 @@ This extension is included in the standard Markdown library.

[MultiMarkdown]: https://fletcherpenney.net/multimarkdown/#metadata

!!! Note

This extension is in __maintenance mode__. We will continue to fix bugs
and keep it up-to-date with the core parser, but no new features or
changes in behavior will be made. If you need a feature that this
extension does not offer, then you have three options (1) find an
existing [third-party extension] which meets your needs, (2) [build your
own extension], or (3) fork this extension (pursuant to its licensing
requirements) and maintain it as a third-party extension.

[third-party extension]: index.md#third-party-extensions
[build your own extension]: api.md

Syntax
------

Expand Down
13 changes: 13 additions & 0 deletions docs/extensions/nl2br.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,19 @@ hard breaks; like StackOverflow and [GitHub][] flavored Markdown do.

[Github]: https://github.github.com/github-flavored-markdown/

!!! Note

This extension is in __maintenance mode__. We will continue to fix bugs
and keep it up-to-date with the core parser, but no new features or
changes in behavior will be made. If you need a feature that this
extension does not offer, then you have three options (1) find an
existing [third-party extension] which meets your needs, (2) [build your
own extension], or (3) fork this extension (pursuant to its licensing
requirements) and maintain it as a third-party extension.

[third-party extension]: index.md#third-party-extensions
[build your own extension]: api.md

Example
-------

Expand Down
13 changes: 13 additions & 0 deletions docs/extensions/sane_lists.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,19 @@ to be less surprising.

This extension is included in the standard Markdown library.

!!! Note

This extension is in __maintenance mode__. We will continue to fix bugs
and keep it up-to-date with the core parser, but no new features or
changes in behavior will be made. If you need a feature that this
extension does not offer, then you have three options (1) find an
existing [third-party extension] which meets your needs, (2) [build your
own extension], or (3) fork this extension (pursuant to its licensing
requirements) and maintain it as a third-party extension.

[third-party extension]: index.md#third-party-extensions
[build your own extension]: api.md

Syntax
------

Expand Down
13 changes: 13 additions & 0 deletions docs/extensions/smarty.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,19 @@ extension_configs = {
[SmartyPants]: https://pythonhosted.org/smartypants/
[CodeHilite]: code_hilite.md

!!! Note

This extension is in __maintenance mode__. We will continue to fix bugs
and keep it up-to-date with the core parser, but no new features or
changes in behavior will be made. If you need a feature that this
extension does not offer, then you have three options (1) find an
existing [third-party extension] which meets your needs, (2) [build your
own extension], or (3) fork this extension (pursuant to its licensing
requirements) and maintain it as a third-party extension.

[third-party extension]: index.md#third-party-extensions
[build your own extension]: api.md

Usage
-----

Expand Down
13 changes: 13 additions & 0 deletions docs/extensions/tables.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,19 @@ The Tables extension adds the ability to create tables in Markdown documents.

This extension is included in the standard Markdown library.

!!! Note

This extension is in __maintenance mode__. We will continue to fix bugs
and keep it up-to-date with the core parser, but no new features or
changes in behavior will be made. If you need a feature that this
extension does not offer, then you have three options (1) find an
existing [third-party extension] which meets your needs, (2) [build your
own extension], or (3) fork this extension (pursuant to its licensing
requirements) and maintain it as a third-party extension.

[third-party extension]: index.md#third-party-extensions
[build your own extension]: api.md

Syntax
------

Expand Down
Loading
Loading