Formatting

Critic

• https://squidfunk.github.io/mkdocs-material/reference/formatting/#highlighting-changes
• https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#critic
• https://facelessuser.github.io/pymdown-extensions/extensions/critic/
• CriticMarkup/CriticMarkup-toolkit

Setup

markdown_extensions:
  - pymdownx.critic:
      mode: view

Examples

• Addition add
• Deletion del
• Substitution oldnew
• Comment comment
• Highlight highlight

Highlight a complete paragraph

Caret, Mark & Tilde

• https://squidfunk.github.io/mkdocs-material/reference/formatting/#highlighting-text
• https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#caret-mark-tilde
• https://facelessuser.github.io/pymdown-extensions/extensions/caret/
• https://facelessuser.github.io/pymdown-extensions/extensions/mark/
• https://facelessuser.github.io/pymdown-extensions/extensions/tilde/

Setup

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

Example

• This was marked
• This was inserted
• This was deleted

Keyboard

• https://squidfunk.github.io/mkdocs-material/reference/formatting/#adding-keyboard-keys
• https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#keys
• https://facelessuser.github.io/pymdown-extensions/extensions/keys/
• https://facelessuser.github.io/pymdown-extensions/extensions/keys/#key-map-index

Setup

markdown_extensions:
  - pymdownx.keys

Examples

• ++space++: Space
• ++return++: Enter
• ++ctrl+c++: Ctrl+C
• ++alt+a++: Alt+A
• ++shift+up++: Shift+Up
• ++windows+page-up++: Win+Page Up