diff --git a/.spell-dict b/.spell-dict index 49c118a2..48984b46 100644 --- a/.spell-dict +++ b/.spell-dict @@ -94,6 +94,7 @@ prepended preprocessor preprocessors Pygments +PyMdown PyPI PyPy PYTHONPATH diff --git a/docs/changelog.md b/docs/changelog.md index 0894a528..49f6d52f 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -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 diff --git a/docs/extensions/abbreviations.md b/docs/extensions/abbreviations.md index 2e8fd74a..1bfa13a0 100644 --- a/docs/extensions/abbreviations.md +++ b/docs/extensions/abbreviations.md @@ -11,6 +11,19 @@ Specifically, any defined abbreviation is wrapped in an `` 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 ------ diff --git a/docs/extensions/admonition.md b/docs/extensions/admonition.md index 4f79d488..c9a71161 100644 --- a/docs/extensions/admonition.md +++ b/docs/extensions/admonition.md @@ -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 ------ diff --git a/docs/extensions/attr_list.md b/docs/extensions/attr_list.md index d3d5e121..04d9eba2 100644 --- a/docs/extensions/attr_list.md +++ b/docs/extensions/attr_list.md @@ -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]). diff --git a/docs/extensions/code_hilite.md b/docs/extensions/code_hilite.md index 19b9d526..322ab8b2 100644 --- a/docs/extensions/code_hilite.md +++ b/docs/extensions/code_hilite.md @@ -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 diff --git a/docs/extensions/definition_lists.md b/docs/extensions/definition_lists.md index 047996ac..94b721f6 100644 --- a/docs/extensions/definition_lists.md +++ b/docs/extensions/definition_lists.md @@ -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 ------ diff --git a/docs/extensions/extra.md b/docs/extensions/extra.md index 77f5de08..8328dfff 100644 --- a/docs/extensions/extra.md +++ b/docs/extensions/extra.md @@ -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: diff --git a/docs/extensions/fenced_code_blocks.md b/docs/extensions/fenced_code_blocks.md index 05d80825..b744c0bf 100644 --- a/docs/extensions/fenced_code_blocks.md +++ b/docs/extensions/fenced_code_blocks.md @@ -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 diff --git a/docs/extensions/footnotes.md b/docs/extensions/footnotes.md index a4b78b20..d596bcf9 100644 --- a/docs/extensions/footnotes.md +++ b/docs/extensions/footnotes.md @@ -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 ------ diff --git a/docs/extensions/index.md b/docs/extensions/index.md index 6481caa1..220e1fe6 100644 --- a/docs/extensions/index.md +++ b/docs/extensions/index.md @@ -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. @@ -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 diff --git a/docs/extensions/legacy_attrs.md b/docs/extensions/legacy_attrs.md index daa566d3..4313e70e 100644 --- a/docs/extensions/legacy_attrs.md +++ b/docs/extensions/legacy_attrs.md @@ -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 diff --git a/docs/extensions/legacy_em.md b/docs/extensions/legacy_em.md index 67c6cd00..8f9ebb94 100644 --- a/docs/extensions/legacy_em.md +++ b/docs/extensions/legacy_em.md @@ -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: `connectedwords_`. +!!! 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 diff --git a/docs/extensions/md_in_html.md b/docs/extensions/md_in_html.md index 06a01d76..75476fdc 100644 --- a/docs/extensions/md_in_html.md +++ b/docs/extensions/md_in_html.md @@ -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 diff --git a/docs/extensions/meta_data.md b/docs/extensions/meta_data.md index 26513242..242e2fb3 100644 --- a/docs/extensions/meta_data.md +++ b/docs/extensions/meta_data.md @@ -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 ------ diff --git a/docs/extensions/nl2br.md b/docs/extensions/nl2br.md index 2c7a1a58..968dc1c7 100644 --- a/docs/extensions/nl2br.md +++ b/docs/extensions/nl2br.md @@ -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 ------- diff --git a/docs/extensions/sane_lists.md b/docs/extensions/sane_lists.md index bb43833b..414d33d4 100644 --- a/docs/extensions/sane_lists.md +++ b/docs/extensions/sane_lists.md @@ -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 ------ diff --git a/docs/extensions/smarty.md b/docs/extensions/smarty.md index d7211c01..8dfb9b1b 100644 --- a/docs/extensions/smarty.md +++ b/docs/extensions/smarty.md @@ -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 ----- diff --git a/docs/extensions/tables.md b/docs/extensions/tables.md index aaffc09e..da44359d 100644 --- a/docs/extensions/tables.md +++ b/docs/extensions/tables.md @@ -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 ------ diff --git a/docs/extensions/toc.md b/docs/extensions/toc.md index 6db62226..9c743205 100644 --- a/docs/extensions/toc.md +++ b/docs/extensions/toc.md @@ -11,6 +11,19 @@ document and adds it into the resulting HTML document. 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 ------ diff --git a/docs/extensions/wikilinks.md b/docs/extensions/wikilinks.md index cd355f74..aff9ea6e 100644 --- a/docs/extensions/wikilinks.md +++ b/docs/extensions/wikilinks.md @@ -11,6 +11,19 @@ This extension is included in the standard Markdown library. [WikiLinks]: https://en.wikipedia.org/wiki/Wikilink +!!! 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 A ``[[bracketed]]`` word is any combination of upper or lower case letters,