Skip to content

Commit 93ac448

Browse files
authored
Document that all extensions are in maintenance mode
This has been the de facto policy for some time. We are now officially documenting it. Relates to #1612. Some recommendations for alternative extensions have been included.
1 parent d38fd4a commit 93ac448

21 files changed

Lines changed: 270 additions & 4 deletions

.spell-dict

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ prepended
9494
preprocessor
9595
preprocessors
9696
Pygments
97+
PyMdown
9798
PyPI
9899
PyPy
99100
PYTHONPATH

docs/changelog.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ See the [Contributing Guide](contributing.md) for details.
1515
### Fixed
1616

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

1920
## [3.10.2] - 2026-02-09
2021

docs/extensions/abbreviations.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,19 @@ Specifically, any defined abbreviation is wrapped in an `<abbr>` tag.
1111

1212
The Abbreviations extension is included in the standard Markdown library.
1313

14+
!!! Note
15+
16+
This extension is in __maintenance mode__. We will continue to fix bugs
17+
and keep it up-to-date with the core parser, but no new features or
18+
changes in behavior will be made. If you need a feature that this
19+
extension does not offer, then you have three options (1) find an
20+
existing [third-party extension] which meets your needs, (2) [build your
21+
own extension], or (3) fork this extension (pursuant to its licensing
22+
requirements) and maintain it as a third-party extension.
23+
24+
[third-party extension]: index.md#third-party-extensions
25+
[build your own extension]: api.md
26+
1427
Syntax
1528
------
1629

docs/extensions/admonition.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,22 @@ This extension is included in the standard Markdown library.
1212

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

15+
!!! Note
16+
17+
This extension is in __maintenance mode__. We will continue to fix bugs
18+
and keep it up-to-date with the core parser, but no new features or
19+
changes in behavior will be made. If you need a feature that this
20+
extension does not offer, then you have three options (1) find an
21+
existing [third-party extension] which meets your needs, (2) [build your
22+
own extension], or (3) fork this extension (pursuant to its licensing
23+
requirements) and maintain it as a third-party extension.
24+
25+
We recommend [PyMdown Admonition] as an actively developed alternative.
26+
27+
[third-party extension]: index.md#third-party-extensions
28+
[build your own extension]: api.md
29+
[PyMdown Admonition]: https://facelessuser.github.io/pymdown-extensions/extensions/blocks/plugins/admonition/
30+
1531
Syntax
1632
------
1733

docs/extensions/attr_list.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,19 @@ HTML elements in markdown's output.
99

1010
This extension is included in the standard Markdown library.
1111

12+
!!! Note
13+
14+
This extension is in __maintenance mode__. We will continue to fix bugs
15+
and keep it up-to-date with the core parser, but no new features or
16+
changes in behavior will be made. If you need a feature that this
17+
extension does not offer, then you have three options (1) find an
18+
existing [third-party extension] which meets your needs, (2) [build your
19+
own extension], or (3) fork this extension (pursuant to its licensing
20+
requirements) and maintain it as a third-party extension.
21+
22+
[third-party extension]: index.md#third-party-extensions
23+
[build your own extension]: api.md
24+
1225
## Syntax
1326

1427
The basic syntax was inspired by Maruku's Attribute Lists feature (see [web archive][Maruku]).

docs/extensions/code_hilite.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,22 @@ Python-Markdown code blocks using [Pygments][].
1111

1212
This extension is included in the standard Markdown library.
1313

14+
!!! Note
15+
16+
This extension is in __maintenance mode__. We will continue to fix bugs
17+
and keep it up-to-date with the core parser, but no new features or
18+
changes in behavior will be made. If you need a feature that this
19+
extension does not offer, then you have three options (1) find an
20+
existing [third-party extension] which meets your needs, (2) [build your
21+
own extension], or (3) fork this extension (pursuant to its licensing
22+
requirements) and maintain it as a third-party extension.
23+
24+
We recommend [Highlight] as an actively developed alternative.
25+
26+
[third-party extension]: index.md#third-party-extensions
27+
[build your own extension]: api.md
28+
[Highlight]: https://facelessuser.github.io/pymdown-extensions/extensions/highlight/
29+
1430
## Setup
1531

1632
### Step 1: Download and Install Pygments

docs/extensions/definition_lists.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,22 @@ Markdown documents.
1111

1212
This extension is included in the standard Markdown library.
1313

14+
!!! Note
15+
16+
This extension is in __maintenance mode__. We will continue to fix bugs
17+
and keep it up-to-date with the core parser, but no new features or
18+
changes in behavior will be made. If you need a feature that this
19+
extension does not offer, then you have three options (1) find an
20+
existing [third-party extension] which meets your needs, (2) [build your
21+
own extension], or (3) fork this extension (pursuant to its licensing
22+
requirements) and maintain it as a third-party extension.
23+
24+
We recommend [PyMdown Definition] as an actively developed alternative.
25+
26+
[third-party extension]: index.md#third-party-extensions
27+
[build your own extension]: api.md
28+
[PyMdown Definition]: https://facelessuser.github.io/pymdown-extensions/extensions/blocks/plugins/definition/
29+
1430
Syntax
1531
------
1632

docs/extensions/extra.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,19 @@ The supported extensions include:
2020
See each individual extension for syntax documentation. Extra and all its
2121
supported extensions are included in the standard Markdown library.
2222

23+
!!! Note
24+
25+
This extension is in __maintenance mode__. We will continue to fix bugs
26+
and keep it up-to-date with the core parser, but no new features or
27+
changes in behavior will be made. If you need a feature that this
28+
extension does not offer, then you have three options (1) find an
29+
existing [third-party extension] which meets your needs, (2) [build your
30+
own extension], or (3) fork this extension (pursuant to its licensing
31+
requirements) and maintain it as a third-party extension.
32+
33+
[third-party extension]: index.md#third-party-extensions
34+
[build your own extension]: api.md
35+
2336
## Usage
2437

2538
From the Python interpreter:

docs/extensions/fenced_code_blocks.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,21 @@ indented code blocks.
99

1010
This extension is included in the standard Markdown library.
1111

12+
!!! Note
13+
14+
This extension is in __maintenance mode__. We will continue to fix bugs
15+
and keep it up-to-date with the core parser, but no new features or
16+
changes in behavior will be made. If you need a feature that this
17+
extension does not offer, then you have three options (1) find an
18+
existing [third-party extension] which meets your needs, (2) [build your
19+
own extension], or (3) fork this extension (pursuant to its licensing
20+
requirements) and maintain it as a third-party extension.
21+
22+
We recommend [SuperFences] as an actively developed alternative.
23+
24+
[third-party extension]: index.md#third-party-extensions
25+
[build your own extension]: api.md
26+
1227
## Syntax
1328

1429
Fenced Code Blocks are defined using the syntax originally established in [PHP Markdown Extra][php] and popularized by

docs/extensions/footnotes.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,19 @@ documents.
1111

1212
This extension is included in the standard Markdown library.
1313

14+
!!! Note
15+
16+
This extension is in __maintenance mode__. We will continue to fix bugs
17+
and keep it up-to-date with the core parser, but no new features or
18+
changes in behavior will be made. If you need a feature that this
19+
extension does not offer, then you have three options (1) find an
20+
existing [third-party extension] which meets your needs, (2) [build your
21+
own extension], or (3) fork this extension (pursuant to its licensing
22+
requirements) and maintain it as a third-party extension.
23+
24+
[third-party extension]: index.md#third-party-extensions
25+
[build your own extension]: api.md
26+
1427
Syntax
1528
------
1629

0 commit comments

Comments
 (0)