pymdown-extensions

8.0

Please see Release Notes for details on upgrading to 8.0.

• NEW: Added SaneHeaders extension.
• NEW: SuperFences & InlineHilite: gracefully handle failing custom formatters and/or validators. Users should add their own debug code to their formatter/validator if they suspect it isn't working.
• NEW: SuperFences: if a custom fence validator fails, try the next custom fence until all are exhausted.
• NEW: SuperFences: no longer allow custom options in the form key= (no value). Only keys with values or keys with no value and no = are accepted. Keys with no value will now assume the value to be the key name.
• NEW: SuperFences: if attr_list extension is enabled, fenced code that use brace attribute list style headers ( ```{lang #id .class attr=value}) will attach arbitrary attributes that are included in the header to the code element.
• NEW: SuperFences: when Pygments is disabled, options (such as linenums) included in fenced code headers no longer do anything. If attr_list is enabled, and the brace header is used, such options will be treated as HTML attributes. JavaScript highlighter options should be defined in the brace header form with attr_list enabled in order to generate appropriate, compatible HTML with the chosen JavaScript highlighter.
• NEW: SuperFences: backwards incompatible changes where made to custom fence API. See Release Notes for instructions on how to migrate to the new API. Some temporary support for most of the old format is in place, but is deprecated.
• NEW: SuperFences: has removed legacy code tab feature. Associated legacy_tab_classes option has been removed. Please use the Tabbed extension to create general purpose tabs for code blocks or other content.
• NEW: Highlight: add new option language_prefix which controls the prefix applied to language classes when Pygments is not being used.
• NEW: Highlight: A new option called code_attr_on_pre was added to the Highlight extension and controls whether language classes, and any ids, attributes, and classes that are defined in fenced code attribute list style headers, are attached to the code element or pre element. This has effect when using Pygments.
• NEW: Highlight: option linenums now defaults to None and accepts None, True, or False. None is disabled by default, but can be enabled per code block. True enables line numbers globally. False disables globally and cannot be enabled manually per code block.
• NEW: ExtraRawHTML: remove extension.
• FIX: Fix issues with complex emphasis combinations in BetterEm.
• FIX: Details: fix corner cases related to extension and lists.
• FIX: Tabbed: fix corner cases related to extension and lists.
• FIX: EscapeAll: Handle HTML entities special.
• FIX: SuperFences: Fix parameter unpacking bug.

7.1

• NEW: SuperFences will now allow number ranges in hl_lines option. (#878)
• NEW: Emoji extension now requires custom emoji indexes to take an options and md argument. The old non-argument format is deprecated and still accepted, but support for indexes with no arguments will be removed at a future time.
• NEW: Highlight now allows the specifying of a custom line number class when not using Pygments.
• FIX: Better Arithmatex patterns. Fix issue #888 which caused a hang due to a regular expression typo. Also ensure #!tex $$..$$ and #!tex begin{}...end{} patterns properly don't match if the tail markers are escaped.

7.0

Please see Release Notes for details on upgrading to 7.0.

• NEW: MagicLink will now shorten user name and repository links when link shortening is enabled.
• NEW: Added MagicLink options social_url_shortener and shortener_user_exclude were added.
• NEW: UML examples are now demonstrated with Mermaid in documentation.
• NEW: SuperFences, if using the attribute list format (``` {.lang .additional_class, linenums="1"}) allows
  adding additional classes. IDs can be added as well, though Pygments generated code blocks do not have a mechanism to
  actually insert IDs. The first provided class will always be treated as the language class.
• NEW: Custom SuperFences' formatters should now also include the keyword parametersclasses and id_value to
  allow injecting classes and IDs via the now supported attribute list format. If a code block defines no additional IDs
  and classes, the old form will be used. Formatters should include **kwargs at the end to future proof them from
  future changes.
• NEW: Deprecate the SuperFences highight_code option. As SuperFences syntax has language classes built right in,
  disabling the highlight_code option makes little sense. While highlight_code is still accepted, it currently does
  nothing and will be removed at some future time.
• NEW: If a custom fence (SuperFences) or inline (InlineHilite) is given the name of *, it will override the
  default fence logic.
• NEW: SuperFences and InlineHilite no longer sync settings from CodeHilite.
• NEW: Add new Tabbed extension for general purpose tabbed content in Markdown.
• NEW: Deprecate old SuperFences tabbed content feature. This will be removed in 8.0.
• NEW: SuperFences' tabbed content classes have changed from supferfences-tabs and superfences-content to
  tabbed-set and tabbed-content respectively. Old style classes can be enabled with the legacy_tab_classes option
  in SuperFences. This new option will be retired with SuperFences tabbed content feature in 8.0.
• NEW: Upgrade to Twemoji 12.1.5.
• NEW: New key codes and key code changes in Keys extension:
  • Added super, left-super, and right-super key codes as an alternative to meta. Aliases lsuper and
    rsuper were also added.
  • Added the alt-graph key code with altgr alias.
  • Added the following new aliases: lwindows and rwindows for consistency.
  • Added new codes left-meta and right-meta for consistency with other modifiers. Aliases lmeta and rmeta
    were also added.
  • Added left-option, right-option, left-command, right-command, left-meta, and right-meta codes for
    consistency across similar modifier keys. Additional aliases were added as well: loption, roption, lopt,
    ropt, left-opt, right-opt, lcommand, rcommand, lcmd, rcmd, left-cmd, right-cmd, lmeta, and
    rmeta.
  • alt no longer uses menu, lmenu, and rmenu as key aliases. context-menu now uses the alias menu.
    context-menu will display with Menu now.
• FIX: Numerous deprecation warnings associated with the recent release of Python Markdown 3.2.
• FIX: Ensure ExtraRawHTML raises a deprecation warning.

7.0rc2

Please see Release Notes for details on upgrading to 7.0.

• NEW: MagicLink will now shorten user name and repository links when link shortening is enabled.
• NEW: Added MagicLink options social_url_shortener and shortener_user_exclude were added.
• NEW: UML examples are now demonstrated with Mermaid in documentation.
• NEW: SuperFences, if using the attribute list format (``` {.lang .additional_class, linenums="1"}) allows
  adding additional classes. IDs can be added as well, though Pygments generated code blocks do not have a mechanism to
  actually insert IDs. The first provided class will always be treated as the language class.
• NEW: Custom SuperFences' formatters should now also include the keyword parametersclasses and id_value to
  allow injecting classes and IDs via the now supported attribute list format. If a code block defines no additional IDs
  and classes, the old form will be used. Formatters should include **kwargs at the end to future proof them from
  future changes.
• NEW: Deprecate the SuperFences highight_code option. As SuperFences syntax has language classes built right in,
  disabling the highlight_code option makes little sense. While highlight_code is still accepted, it currently does
  nothing and will be removed at some future time.
• NEW: If a custom fence (SuperFences) or inline (InlineHilite) is given the name of *, it will override the
  default fence logic.
• NEW: SuperFences and InlineHilite no longer sync settings from CodeHilite.
• NEW: Add new Tabbed extension for general purpose tabbed content in Markdown.
• NEW: Deprecate old SuperFences tabbed content feature. This will be removed in 8.0.
• NEW: SuperFences' tabbed content classes have changed from supferfences-tabs and superfences-content to
  tabbed-set and tabbed-content respectively. Old style classes can be enabled with the legacy_tab_classes option
  in SuperFences. This new option will be retired with SuperFences tabbed content feature in 8.0.
• NEW: Upgrade to Twemoji 12.1.5.
• NEW: New key codes and key code changes in Keys extension:
  • Added super, left-super, and right-super key codes as an alternative to meta. Aliases lsuper and
    rsuper were also added.
  • Added the alt-graph key code with altgr alias.
  • Added the following new aliases: lwindows and rwindows for consistency.
  • Added new codes left-meta and right-meta for consistency with other modifiers. Aliases lmeta and rmeta
    were also added.
  • Added left-option, right-option, left-command, right-command, left-meta, and right-meta codes for
    consistency across similar modifier keys. Additional aliases were added as well: loption, roption, lopt,
    ropt, left-opt, right-opt, lcommand, rcommand, lcmd, rcmd, left-cmd, right-cmd, lmeta, and
    rmeta.
  • alt no longer uses menu, lmenu, and rmenu as key aliases. context-menu now uses the alias menu.
    context-menu will display with Menu now.
• FIX: Numerous deprecation warnings associated with the recent release of Python Markdown 3.2.
• FIX: Ensure ExtraRawHTML raises a deprecation warning.

7.0rc1

• NEW: SuperFences, if using the attribute list format (``` {.lang .additional_class, linenums="1"}) allows
  adding additional classes. IDs can be added as well, though Pygments generated code blocks do not have a mechanism to actually insert IDs. The first provided class will always be treated as the language class.
• NEW: Custom SuperFences' formatters should now also include the keyword parametersclasses and id_value to allow injecting classes and IDs via the now supported attribute list format. If a code block defines no additional IDs and classes, the old form will be used. Formatters should include **kwargs at the end to future proof them from future changes.
• NEW: Deprecate the SuperFences highight_code option. As SuperFences syntax has language classes built right in, disabling the highlight_code option makes little sense. While highlight_code is still accepted, it currently does nothing and will be removed at some future time.
• NEW: If a custom fence (SuperFences) or inline (InlineHilite) is given the name of *, it will override the
  default fence logic.
• NEW: SuperFences and InlineHilite no longer sync settings from CodeHilite.
• NEW: Add new Tabbed extension for general purpose tabbed content in Markdown.
• NEW: Deprecate old SuperFences tabbed content feature. This will be removed in 8.0.
• NEW: SuperFences' tabbed content classes have changed from supferfences-tabs and superfences-content to tabbed-set and tabbed-content respectively. Old style classes can be enabled with the legacy_tab_classes option in SuperFences. This new option will be retired with SuperFences tabbed content feature in 8.0.
• NEW: Upgrade to Twemoji 12.1.5.
• NEW: New key codes and key code changes in Keys extension:
  • Added super, left-super, and right-super key codes as an alternative to meta. Aliases lsuper and
    rsuper were also added.
  • Added the alt-graph key code with altgr alias.
  • Added the following new aliases: lwindows and rwindows for consistency.
  • Added new codes left-meta and right-meta for consistency with other modifiers. Aliases lmeta and rmeta were also added.
  • Added left-option, right-option, left-command, right-command, left-meta, and right-meta codes for consistency across similar modifier keys. Additional aliases were added as well: loption, roption, lopt, ropt, left-opt, right-opt, lcommand, rcommand, lcmd, rcmd, left-cmd, right-cmd, lmeta, and rmeta.
  • alt no longer uses menu, lmenu, and rmenu as key aliases. context-menu now uses the alias menu. context-menu will display with Menu now.
• FIX: Numerous deprecation warnings associated with the recent release of Python Markdown 3.2.
• FIX: Ensure ExtraRawHTML raises a deprecation warning.

7.0b2

Please see Release Notes for details on upgrading to 7.0.

• NEW: SuperFences, if using the attribute list format (``` {.lang .additional_class, linenums="1"}) allows
  adding additional classes. IDs can be added as well, though Pygments generated code blocks do not have a mechanism to actually insert IDs. The first provided class will always be treated as the language class.
• NEW: Custom SuperFences' formatters should now also include the keyword parametersclasses and id_value to allow injecting classes and IDs via the now supported attribute list format. If a code block defines no additional IDs and classes, the old form will be used. Formatters should include **kwargs at the end to future proof them from future changes.
• NEW: Deprecate the SuperFences highight_code option. As SuperFences syntax has language classes built right in, disabling the highlight_code option makes little sense. While highlight_code is still accepted, it currently does nothing and will be removed at some future time.
• NEW: If a custom fence (SuperFences) or inline (InlineHilite) is given the name of *, it will override the
  default fence logic.- NEW: SuperFences and InlineHilite no longer sync settings from CodeHilite.

7.0.0b1

• NEW: Add new Tabbed extension for general purpose tabbed content in Markdown.
• NEW: Deprecate old SuperFences tabbed content feature. This will be removed in 8.0.0.
• NEW: SuperFences' tabbed content classes have changed from supferfences-tabs and superfences-content to
  tabbed-set and tabbed-content respectively. Old style classes can be enabled with the legacy_tab_classes option
  in SuperFences. This new option will be retired with SuperFences tabbed content feature in 8.0.0.
• FIX: Numerous deprecation warnings associated with the recent release of Python Markdown 3.2.

6.3.0

• NEW: pymdownx.extrarawhtml is now deprecated in favor of Python Markdown's md_in_html extension found in the
  3.2 release.
• NEW: When using Pygments 2.4+, code under pre elements will also be wrapped in code blocks:
  #!html <pre><code></code></pre>. legacy_no_wrap_code option has been provided as a temporary way to get the old
  behavior during the transition period, the option will be removed in the future.
• NEW: Remove deprecated version and version_info.
• FIX: Allow single word hostnames in MagicLink auto-link.

6.2.1

• FIX: Fix issue in PathConverter where Windows path conversion from relative to absolute doesn't always work in all browsers.

6.2.0

• NEW: Upgrade Twemoji to use 12.1.3.
• NEW: Downgrade and lock EmojiOne version 2.2.7. 2.2.7 is the last truly free version of EmojiOne. This is the safest version that users should use. EmojiOne will not be updated anymore as they are now JoyPixels and have a license that is not that permissible. We've reverted support for any version greater than 2.2.7 to ensure we don't accidentally cause a user to improperly use JoyPixels' assets.
• NEW: Drop specialized to_awesome generator for EmojiOne.
• FIX: MagicLink: match the auto-link pattern in the current Markdown package.
• FIX: Fix fenced math escape issue when using MathJax script output format.

6.1.0

• NEW: Upgrade Twemoji to 12.1.2 using the latest JoyPixels' (formally EmojiOne) short name index in @JoyPixels/emoji-toolkit 5.0.4.
• NEW: Upgrade EmojiOne to 4.5.0 to the last release in the 4+ series. EmojiOne was rebranded as JoyPixels, but while the index is licensed under MIT, the image assets are no longer as permissible as they once were. The Emoji extension will only reference the last release under the older more permissible license (4.5.0). The option to use the CDN with EmojiOne 2.7 is still available as well which used an even more permissible license.
• NEW: Upgrade Gemoji to 3.0.1.
• NEW: version and version_info are now accessible via the more standard form __version__ and _version_info__. The old format, while available, is now deprecated.
• FIX: Fix GitHub emoji CDN links to use their latest.
• FIX: Fix issue where entities in the form # would trigger MagicLink's shorthand for issues.
• FIX: Don't install tests when installing package.
• FIX: Fix for BetterEm case **Strong*em,strong***.
• FIX: Fixes for non-word character boundary cases in BetterEm, Caret, Mark, and Tilde extensions.

6.0.0

Please see Release Notes in documentation for details on upgrading to 6.0.0.

• NEW: Allow custom inline highlight code blocks. (#380)
• NEW: SuperFences now has one custom format convention which now also accepts the markdown class object to allow access to meta.
• NEW: SuperFences no longer adds flow and sequence as default custom fences. Users will need to configure them themselves.
• NEW: Add new SuperFences formatters in Arithmatex that are compatible with SuperFences' custom fence feature and InlineHilite's custom inline feature. (#380)
• NEW: Requires Python Markdown 3.0.1 and utilizes the new priority registry when adding extensions and uses the new inline processor API instead of the old methodology.
• NEW: Better aliases for Twemoji specific emoji.
• NEW: Upgrade support for EmojiOne to 4.0.0 and Twemoji to 11.2.0.
• FIX: Fixes to SuperFences behavior of "preserve tabs" vs "normal" operations.
• FIX: Fixes to PathConverter's output. (#392)
• FIX: Remove unnecessary path code in B64.
• FIX: Fix issues with double escaping entities in code blocks after Python Markdown 3.0 update.

5.0.0

• NEW: Add validator to custom fences so custom options can be used. (#350)
• NEW: Add global linenums_special option to Highlight extension. Can be overridden per fence in SuperFences. (#360)
• NEW: Add linenums_style option to set line number output to Pygments table or inline format. Also provide a custom pymdownx-inline format for more sane inline output in regards to copy and paste. See Highlight documentation for more info. (#360)
• NEW: Remove deprecated Github and PlainHTML extension. Remove deprecated Arithmatex option insert_as_script and deprecated MagicLink option base_repo_url.
• FIX: Add workaround in Highlight extension for line number alignment issues in Pygments with certain step values. (#360)

4.12.0

• NEW: Add option to fail if specified snippet isn't found. (#335)
• FIX: Windows issue with preserve_tabs option in SuperFences. (#328)

4.11.0

Jun 10, 2018

• NEW: Allow Arithmatex's "smart dollar" logic to be turned off via setting the option smart_dollar to False (#297).
• NEW: Add support for tabbed groups in SuperFences.

4.10.2

May 17, 2018

• FIX: Failure with code highlight when guessing is enabled, but a bad language name is provided.

4.10.1

Apr 29, 2018

• FIX: Update Twemoji to 2.6.0 and EmojiOne 3.1.3.

4.10.0

Apr 18, 2018

• NEW: SuperFences now adds experimental support for preserving tabs in fenced code blocks. (#276)

4.9.2

Mar 26, 2018

• FIX: Issues with task lists that span multiple lines. (#267)
• FIX: Require latest Python Markdown.

4.9.1

Mar 18, 2018

• FIX: Output issue when no user and/or repository is specified.