Markdown

Our special mix of Markdown plugins:

plantuml-markdown

Plant UML diagram

Markdown

```plantuml format="svg" alt="My super  diagram placeholder"   width="400px"  height="400px"
title Authentication Sequence
Alice ->  Bob: calls
Alice <-- Bob: responds
```

Output

codehilite

Syntax highlighting in fenced code blocks.

Syntax highlighting

Markdown

```typescript
import { NodeCG } from "nodecg-types/types/server";
module.exports = (nodecg: NodeCG) => {
    new YourServiceNameService(nodecg, "your-service-name", __dirname, "../your-service-name-schema.json").register();
};
```

Output

import { NodeCG } from "nodecg-types/types/server";
module.exports = (nodecg: NodeCG) => {
    new YourServiceNameService(nodecg, "your-service-name", __dirname, "../your-service-name-schema.json").register();
};

pymdownx.inlinehilite

Inline Highlighted Code Example

Markdown

`` Here is some code: `#!py3 import pymdownx; pymdownx__version__`.

The mock shebang will be treated like text here: ` #!js vartest = 0; `. ``

Output

Here is some code: import pymdownx; pymdownx.__version__

The mock shebang will be treated like text here: #!js var test = 0;.

pymdownx.superfences

1. Allowing the nesting of fences under blockquotes, lists, or other block elements.
2. Ability to specify custom fences to provide features like flowcharts, sequence diagrams, or other custom blocks.
3. Allow disabling of indented code blocks in favour of only using the fenced variant (off by default).
4. Experimental feature that preserves tabs within a code block instead of converting them to spaces which is Python Markdown's default behaviour.

pymdownx.tabbed

Example Tabs

Markdown

=== "Tab 1"

    Markdown **content**.

    Multiple paragraphs.

=== "Tab 2"

    More Markdown **content**.

    - list item a
    - list item b

Output

Tab 1

Markdown content.

Multiple paragraphs.

Tab 2

More Markdown content.

• list item a
• list item b

pymdownx.tasklist

GFM style task lists

Task lists

Markdown

- [X] item 1
  * [X] item A
    * [ ] item B
        more text
        + [x] item a
        + [ ] item b
        + [x] item c
    * [X] item C
- [ ] item 2
- [ ] item 3

Output

• item 1
• item A
  • item B more text
    • item a
    • item b
    • item c
  • item C
• item 2
• item 3

admonition

Possible types are:
NOTE, SUMMARY, ABSTRACT, TLDR, INFO, TODO, TIP, HINT, SUCCESS, CHECK, DONE, QUESTION, HELP, FAQ, WARNING, ATTENTION, CAUTION, FAILURE, FAIL, MISSING, DANGER, ERROR, BUG, EXAMPLE, SNIPPET, QUOTE, CITE

Inline Highlighted Code Example

Markdown

!!! HINT "optional explicit title within double quotes"

    Any number of other indented markdown elements.

    This is the second paragraph.

Output

optional explicit title within double quotes

Any number of other indented markdown elements.

This is the second paragraph.