PyMdown Extensions

The PyMdown Extensions package is an excellent collection of extensions suited for advanced technical writing. Terminal for MkDocs lists this package as an explicit dependency so it's automatically installed with a supported version.

Suggested PyMdown Extensions

Caret, Mark & Tilde

The Caret, Mark, and Tilde extensions add the ability to highlight text and define subscript 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 Terminal for MkDocs, as they only impact the Markdown parsing stage.

See reference for usage:

• Adding Superscript Styling
• Adding Subscript Styling
• Adding Strikethrough Styling
• Adding Marks

Snippets

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 Terminal for MkDocs, as they only impact the Markdown parsing stage. See the Snippets documentation for more information.

See reference for usage:

• Adding Snippets

Credit

This documentation page is based on squidfunk's Material for MkDocs Pymdown Extension documentation.