Markdown Extensions

The following extensions are supported (see description of some of them here):

• Abbreviation
• Admonition
• AnchorLink
• Attributes
• Autolink
• Definition
• Footnotes
• Emoji
• GfmTaskList
• Gitlab
• PlantUML
• MediaTags
• TableOfContents
• Tables
• Typographic

Abbreviation

🔝

Hover over the following abbreviation: HTML.

Admonition

🔝

Nested elements are supported:

AnchorLink

🔝

Creates links to section headers: link.

Attributes

🔝

HTML attributes include for example CSS for any text.

Autolink

🔝

Makes links clickable: https://www.example.com.

Definition

🔝

Creates definition lists using <dt> / <dd>:

Term 1

Definition 1

Term 2

Definition 2

Footnotes

🔝

What’s CSS¹, see page bottom.

Emoji

🔝

The full set of emotions isn’t formally defined, but generally includes the following: Github list.

😄 👍 🎉

GfmTaskList

🔝

•  task completed
•  task not completed

Gitlab

🔝

Provides all Markdown features that Gitlab supports, for example Mermaid diagrams (see supported diagram types):

---
title: Tea & Coffee (State) Machine
---
stateDiagram-v2
    direction LR
    state ChooseWhatToMake <<choice>>
    
    %% labels
    state "Waiting for button press" as WaitForButton
    state "Boil water" as BoilWater
    state "Make coffee" as MakeCoffee
    state "Make tea" as MakeTea
    state "Add lemon" as AddLemon
    state "Add sugar" as AddSugar
    state "Notify customer" as SignalReady
    
    %% styles
    classDef TeaClass fill:#752400
    classDef CoffeeClass fill:#a76939,color:white
    class MakeTea TeaClass
    class MakeCoffee CoffeeClass
    
    [*] --> WaitForButton: Machine switched on
    WaitForButton --> BoilWater: Button pressed
    BoilWater --> ChooseWhatToMake: Water boiled
    
    %% choice: tea
    ChooseWhatToMake --> MakeTea: Make tea?
    state MakeTea {
        direction LR
        AddLemon --> AddSugar
    }
    MakeTea --> SignalReady: Tea ready
    
    %% choice: coffee
    ChooseWhatToMake --> MakeCoffee: Make coffee?
    note right of MakeCoffee
        Instant coffee / ground coffee / bean coffee.
    end note
    MakeCoffee --> SignalReady: Coffee ready
    
    SignalReady --> WaitForButton: Cup taken

---

gitGraph title Git Commits
    commit id: "Initial commit" tag: "v1.0.0"
    branch develop
    commit
    branch bugfix/TICKET-1
    commit
    commit
    checkout develop
    commit
    merge bugfix/TICKET-1
    checkout main
    merge develop tag: "v1.0.1"

---

pie title Weather Last Month (Pie Chart)
    "Sunny days" : 22
    "Rainy days" : 5
    "Foggy days" : 3

PlantUML

🔝

Renders PlantUML diagrams:

MediaTags

🔝

Embeds remote media:

audio:

web page:

picture:

video:

TableOfContents

🔝

See page top.

Tables

🔝

Header 1	Header 2
Content 1	Content 2
Content 3	Content 4

Typographic

🔝

Converts to pretty HTML entities:

• “double quotes”
• ‘double quotes’
• «angle brackets»
• ellipsis: …
• short dash: –
• long dash: —