mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-11-24 23:50:13 +01:00

2023-05-23 17:42:25 +02:00

27 KiB

Raw Blame History

Python Markdown Extensions

The Python Markdown Extensions package is an excellent collection of additional extensions perfectly suited for advanced technical writing. Material for MkDocs lists this package as an explicit dependency, so it's automatically installed with a supported version.

Supported extensions

In general, all extensions that are part of Python Markdown Extensions should work with Material for MkDocs. The following list includes all extensions that are natively supported, meaning they work without any further adjustments.

Arithmatex

:octicons-tag-24: 1.0.0 · :octicons-workflow-24: Extension

The Arithmatex extension allows for rendering of block and inline block equations and integrates seamlessly with [MathJax]¹ – a library for mathematical typesetting. Enable it via mkdocs.yml:

markdown_extensions:
  - pymdownx.arithmatex:
      generic: true

Besides enabling the extension in mkdocs.yml, a MathJax configuration and the JavaScript runtime need to be included, which can be done with a few lines of additional JavaScript:

=== ":octicons-file-code-16: docs/javascripts/mathjax.js"

``` js
window.MathJax = {
  tex: {
    inlineMath: [["\\(", "\\)"]],
    displayMath: [["\\[", "\\]"]],
    processEscapes: true,
    processEnvironments: true
  },
  options: {
    ignoreHtmlClass: ".*|",
    processHtmlClass: "arithmatex"
  }
};

document$.subscribe(() => {
  MathJax.typesetPromise()
})
```

=== ":octicons-file-code-16: mkdocs.yml"

``` yaml
extra_javascript:
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
```

The other configuration options of this extension are not officially supported by Material for MkDocs, which is why they may yield unexpected results. Use them at your own risk.

See reference for usage:

BetterEm

:octicons-tag-24: 0.1.0 · :octicons-workflow-24: Extension

The BetterEm extension improves the detection of Markup to emphasize text in Markdown using special characters, i.e. for **bold** and _italic_ formatting. Enable it via mkdocs.yml:

markdown_extensions:
  - pymdownx.betterem

The configuration options of this extension are not specific to Material for MkDocs, as they only impact the Markdown parsing stage. See the BetterEm documentation for more information.

Caret, Mark & Tilde

:octicons-tag-24: 1.0.0 · :octicons-workflow-24: Extension

The Caret, Mark and Tilde extensions add the ability to highlight text and define sub- and superscript using a simple syntax. Enable them together via mkdocs.yml:

markdown_extensions:
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde

The configuration options of this extension are not specific to Material for MkDocs, as they only impact the Markdown parsing stage. See the Caret, Mark and Tilde documentation for guidance.

See reference for usage:

Critic

:octicons-tag-24: 1.0.0 · :octicons-workflow-24: Extension

The Critic extension allows for the usage of Critic Markup to highlight added, deleted or updated sections in a document, i.e. for tracking changes in Markdown syntax. Enable it via mkdocs.yml:

markdown_extensions:
  - pymdownx.critic

The following configuration options are supported:

mode{ #+pymdownx.critic.mode }

:octicons-milestone-24: Default: view – This option defines how the markup should be parsed, i.e. whether to just view all suggested changes, or alternatively accept or reject them:

=== "View changes"

``` yaml
markdown_extensions:
  - pymdownx.critic:
      mode: view
```

=== "Accept changes"

``` yaml
markdown_extensions:
  - pymdownx.critic:
      mode: accept
```

=== "Reject changes"

``` yaml
markdown_extensions:
  - pymdownx.critic:
      mode: reject
```

See reference for usage:

Highlighting changes

Details

:octicons-tag-24: 1.9.0 · :octicons-workflow-24: Extension

The Details extension supercharges the Admonition extension, making the resulting call-outs collapsible, allowing them to be opened and closed by the user. Enable it via mkdocs.yml:

markdown_extensions:
  - pymdownx.details

No configuration options are available. See reference for usage:

Collapsible blocks

Emoji

:octicons-tag-24: 1.0.0 · :octicons-workflow-24: Extension

The Emoji extension automatically inlines bundled and custom icons and emojis in *.svg file format into the resulting HTML page. Enable it via mkdocs.yml:

markdown_extensions:
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji # (1)!
      emoji_generator: !!python/name:materialx.emoji.to_svg

Python Markdown Extensions uses the pymdownx namespace, but in order to support the inlining of icons, the materialx namespace must be used, as it extends the functionality of pymdownx.

The following configuration options are supported:

emoji_index{ #+pymdownx.emoji.emoji_index }

:octicons-milestone-24: Default: emojione – This option defines which set of emojis is used for rendering. Note that the use of emojione is not recommended due to restrictions in licensing:

markdown_extensions:
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji

emoji_generator{ #+pymdownx.emoji.emoji_generator }

:octicons-milestone-24: Default: to_png – This option defines how the resolved emoji or icon shortcode is render. Note that icons can only be used together with the to_svg configuration:

markdown_extensions:
  - pymdownx.emoji:
      emoji_generator: !!python/name:materialx.emoji.to_svg

options.custom_icons{ #+pymdownx.emoji.options.custom_icons }

:octicons-milestone-24: Default: none – This option allows to list folders with additional icon sets to be used in Markdown or mkdocs.yml, which is explained in more detail in the icon customization guide:

markdown_extensions:
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
      options:
        custom_icons:
          - overrides/.icons

The other configuration options of this extension are not officially supported by Material for MkDocs, which is why they may yield unexpected results. Use them at your own risk.

See reference for usage:

Highlight

:octicons-tag-24: 5.0.0 · :octicons-workflow-24: Extension · :octicons-zap-24: Supersedes CodeHilite

The Highlight extension adds support for syntax highlighting of code blocks (with the help of SuperFences) and inline code blocks (with the help of InlineHilite). Enable it via mkdocs.yml:

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences # (1)!

Highlight is used by the SuperFences extension to perform syntax highlighting on code blocks, not the other way round, which is why this extension also needs to be enabled.

The following configuration options are supported:

use_pygments{ #+pymdownx.highlight.use_pygments }

:octicons-milestone-24: Default: true – This option allows to control whether highlighting should be carried out during build time using Pygments or in the browser with a JavaScript syntax highlighter:

=== "Pygments"

``` yaml
markdown_extensions:
  - pymdownx.highlight:
      use_pygments: true
  - pymdownx.superfences
```

=== "JavaScript"

``` yaml
markdown_extensions:
  - pymdownx.highlight:
      use_pygments: false
```

As an example, [Highlight.js], a JavaScript syntax highlighter, can be 
integrated with some [additional JavaScript] and an [additional style
sheet] in `mkdocs.yml`:

=== ":octicons-file-code-16: `docs/javascripts/highlight.js`"

    ``` js
    document$.subscribe(() => {
      hljs.highlightAll()
    })
    ```

=== ":octicons-file-code-16: `mkdocs.yml`"

    ``` yaml
    extra_javascript:
      - https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.7.2/highlight.min.js
      - javascripts/highlight.js
    extra_css:
      - https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.7.2/styles/default.min.css
    ```

Note that [Highlight.js] has no affiliation with the
[Highlight][pymdownx.highlight] extension.

All following configuration options are only compatible with build-time syntax highlighting using Pygments, so they don't apply if use_pygments is set to false.

pygments_lang_class{ #+pymdownx.highlight.pygments_lang_class }

:octicons-milestone-24: Default: false – This option instructs Pygments to add a CSS class to identify the language of the code block, which is essential for custom annotation markers to function:

markdown_extensions:
  - pymdownx.highlight:
      pygments_lang_class: true

auto_title{ #+pymdownx.highlight.auto_title }

:octicons-milestone-24: Default: false – This option will automatically add a title to all code blocks that shows the name of the language being used, e.g. Python is printed for a py block:

markdown_extensions:
  - pymdownx.highlight:
      auto_title: true

linenums{ #+pymdownx.highlight.linenums }

:octicons-milestone-24: Default: false – This option will add line numbers to all code blocks. If you wish to add line numbers to some, but not all code blocks, consult the section on adding line numbers in the code block reference, which also contains some tips on working with line numbers:

markdown_extensions:
  - pymdownx.highlight:
      linenums: true

linenums_style{ #+pymdownx.highlight.linenums_style }

:octicons-milestone-24: Default: table – The Highlight extension provides three ways to add line numbers, two of which are supported by Material for MkDocs. While table wraps a code block in a <table> element, pymdownx-inline renders line numbers as part of the line itself:

markdown_extensions:
  - pymdownx.highlight:
      linenums_style: pymdownx-inline

Note that inline will put line numbers next to the actual code, which means that they will be included when selecting text with the cursor or copying a code block to the clipboard. Thus, the usage of either table or pymdownx-inline is recommended.

anchor_linenums{ #+pymdownx.highlight.anchor_linenums }

:octicons-tag-24: 8.1.0 · :octicons-milestone-24: Default: false – If a code blocks contains line numbers, enabling this setting will wrap them with anchor links, so they can be hyperlinked and shared more easily:

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true

line_spans{ #+pymdownx.highlight.line_spans }

:octicons-milestone-24: Default: none – When this option is set, each line of a code block is wrapped in a span, which is essential for features like line highlighting to work correctly:

markdown_extensions:
  - pymdownx.highlight:
      line_spans: __span

The other configuration options of this extension are not officially supported by Material for MkDocs, which is why they may yield unexpected results. Use them at your own risk.

See reference for usage:

InlineHilite

:octicons-tag-24: 5.0.0 · :octicons-workflow-24: Extension

The InlineHilite extension add support for syntax highlighting of inline code blocks. It's built on top of the Highlight extension, from which it sources its configuration. Enable it via mkdocs.yml:

markdown_extensions:
  - pymdownx.highlight
  - pymdownx.inlinehilite

The configuration options of this extension are not specific to Material for MkDocs, as they only impact the Markdown parsing stage. The only exception is the css_class option, which must not be changed. See the InlineHilite documentation for guidance.

See reference for usage:

Highlighting inline code blocks

Keys

:octicons-tag-24: 1.0.0 · :octicons-workflow-24: Extension

The Keys extension adds a simple syntax to allow for the rendering of keyboard keys and combinations, e.g. ++ctrl+alt+del++. Enable it via mkdocs.yml:

markdown_extensions:
  - pymdownx.keys

The configuration options of this extension are not specific to Material for MkDocs, as they only impact the Markdown parsing stage. The only exception is the class option, which must not be changed. See the Keys documentation for more information.

See reference for usage:

Adding keyboard keys

SmartSymbols

:octicons-tag-24: 0.1.0 · :octicons-workflow-24: Extension

The SmartSymbols extension converts some sequences of characters into their corresponding symbols, e.h. copyright symbols or fractions. Enable it via mkdocs.yml:

markdown_extensions:
  - pymdownx.smartsymbols

The configuration options of this extension are not specific to Material for MkDocs, as they only impact the Markdown parsing stage. See the SmartSymbols documentation for guidance.

Snippets

:octicons-tag-24: 0.1.0 · :octicons-workflow-24: Extension

The Snippets extension adds the ability to embed content from arbitrary files into a document, including other documents or source files, by using a simple syntax. Enable it via mkdocs.yml:

markdown_extensions:
  - pymdownx.snippets

The configuration options of this extension are not specific to Material for MkDocs, as they only impact the Markdown parsing stage. See the Snippets documentation for more information.

See reference for usage:

SuperFences

:octicons-tag-24: 0.1.0 · :octicons-workflow-24: Extension · :octicons-zap-24: Supersedes Fenced Code Blocks

The SuperFences extension allows for arbitrary nesting of code and content blocks inside each other, including admonitions, tabs, lists and all other elements. Enable it via mkdocs.yml:

markdown_extensions:
  - pymdownx.superfences

The following configuration options are supported:

custom_fences{ #+pymdownx.superfences.custom_fences }

:octicons-milestone-24: Default: none – This option allows to define a handler for custom fences, e.g. to preserve the definitions of Mermaid.js diagrams to be interpreted in the browser:

markdown_extensions:
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

Note that this will primarily prevent syntax highlighting from being applied. See the reference on diagrams to learn how Mermaid.js is integrated with Material for MkDocs.

The other configuration options of this extension are not officially supported by Material for MkDocs, which is why they may yield unexpected results. Use them at your own risk.

See reference for usage:

Tabbed

:octicons-tag-24: 5.0.0 · :octicons-workflow-24: Extension

The Tabbed extension allows the usage of content tabs, a simple way to group related content and code blocks under accessible tabs. Enable it via mkdocs.yml:

markdown_extensions:
  - pymdownx.tabbed:
      alternate_style: true

The following configuration options are supported:

alternate_style{ #+pymdownx.tabbed.alternate_style }

:octicons-tag-24: 7.3.1 · :octicons-milestone-24: Default: false · :octicons-alert-24: Required – This option enables the content tabs alternate style, which has better behavior on mobile viewports, and is the only supported style:

markdown_extensions:
  - pymdownx.tabbed:
      alternate_style: true

slugify{ #+pymdownx.tabbed.slugify }

:octicons-milestone-24: Default: headerid.slugify – This option allows for customization of the slug function. For some languages, the default may not produce good and readable identifiers – consider using another slug function like for example those from Python Markdown Extensions:

=== "Unicode"

``` yaml
markdown_extensions:
  - pymdownx.tabbed:
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
```

=== "Unicode, case-sensitive"

``` yaml
markdown_extensions:
  - pymdownx.tabbed:
      slugify: !!python/object/apply:pymdownx.slugs.slugify
```

The other configuration options of this extension are not officially supported by Material for MkDocs, which is why they may yield unexpected results. Use them at your own risk.

See reference for usage:

Tasklist

:octicons-tag-24: 1.0.0 · :octicons-workflow-24: Extension

The Tasklist extension allows for the usage of GitHub Flavored Markdown inspired task lists, following the same syntactical conventions. Enable it via mkdocs.yml:

markdown_extensions:
  - pymdownx.tasklist:
      custom_checkbox: true

The following configuration options are supported:

custom_checkbox{ #+pymdownx.tasklist.custom_checkbox }

:octicons-milestone-24: Default: false · This option toggles the rendering style of checkboxes, replacing native checkbox styles with beautiful icons, and is therefore recommended:

markdown_extensions:
  - pymdownx.tasklist:
      custom_checkbox: true

clickable_checkbox{ #+pymdownx.tasklist.clickable_checkbox }

:octicons-milestone-24: Default: false · This option toggles whether checkboxes are clickable. As the state is not persisted, the use of this option is rather discouraged from a user experience perspective:

markdown_extensions:
  - pymdownx.tasklist:
      clickable_checkbox: true

The other configuration options of this extension are not officially supported by Material for MkDocs, which is why they may yield unexpected results. Use them at your own risk.

See reference for usage:

Using task lists

Other libraries like KaTeX are also supported and can be integrated with some additional effort. See the Arithmatex documentation on KaTeX for further guidance, as this is beyond the scope of Material for MkDocs. ↩︎

27 KiB Raw Blame History Unescape Escape

Python Markdown Extensions

Supported extensions

Arithmatex

BetterEm

Caret, Mark & Tilde

Critic

Details

Emoji

Highlight

InlineHilite

Keys

SmartSymbols

Snippets

SuperFences

Tabbed

Tasklist

27 KiB

Raw Blame History