Markdown Extra Example

Markdown Demo Page

This page demonstrates all well-known markdown and markdown extra elements.

Table of Contents

• Headers
• Text Formatting
• Lists
• Links and Images
• Code
• Tables
• Blockquotes
• Horizontal Rules
• HTML Elements
• Markdown Extra Features

Headers

Header 1

Header 2

Header 3

Header 4

Header 5

Header 6

Not allowed: Alternative H1 or Alternative H2

Text Formatting

Bold text or bold text

Italic text or italic text

Bold and italic or bold and italic

Strikethrough text

Highlighted text (if supported)

Subscript: H₂O

Superscript: X²

Lists

Unordered Lists

• Item 1
• Item 2
  • Subitem 2.1
  • Subitem 2.2
    • Sub-subitem 2.2.1
• Item 3

Alternative syntax:

• Item A
• Item B
  • Subitem B.1
  • Subitem B.2

Ordered Lists

1. First item
2. Second item
   1. Subitem 2.1
   2. Subitem 2.2
3. Third item

Task Lists

• Completed task

  Task Description

• Incomplete task with subtasks

  Task Description

  • Completed subtask
  • Another completed subtask
  • Incomplete subtask
• Another incomplete task
• Simple completed task without description
• Simple incomplete task without description

Definition Lists

Term 1

Definition 1

Term 2

Definition 2a

Definition 2b

Complex Term with Multiple Words

This is a longer definition that spans multiple words and shows how the styling works with more content.

Single Definition Term

Just one definition here.

Admonitions

Note - Admonitions need indented content

The content of an admonition must be indented by four spaces. Everything that is indented belongs to the block, the first line that is no longer indented ends it.

Warning - Keep a blank line between paragraphs

Consecutive indented lines are rendered as a single paragraph, so this sentence and the previous one end up in the same block of text.

To start a new paragraph inside an admonition, leave one empty line between the two blocks and keep the indentation of the following lines.

Error - Missing image files break the build

If a referenced image does not exist in the page folder, the page still renders but shows a broken image. Always add the file next to the index.md that references it.

Danger - Never commit credentials

Documentation pages are published publicly. Do not paste passwords, API keys or personal data into examples, use placeholders such as <your-token> instead.

Success - Page structure is complete

A page that contains a title in the front matter, a Uuid on the main page and correctly named folders is ready to be published without further changes.

Info - Supported admonition types

The types note, warning, error, danger, success, info, example and tip are available. Any other type falls back to the default styling.

Example - Referencing another page

Link to a sibling page with a relative path, for example [Image handling](../images/). The numeric folder prefixes are stripped from the URL, so they must not appear in the link.

Tip - Reuse this demo page

Copy this page into your own documentation while you set up the styling, then delete it once you no longer need a reference for the available elements.

Tipp

An admonition with an empty title renders without a header line. Use it when the surrounding text already explains the context and a title would only repeat it.

Links and Images

Links

Inline link

Link with title

Reference link

Another reference link

https://example.com

Images

Videos

Example Video

Code

Inline Code

Use inline code for small snippets.

Code Blocks

Plain code block
No syntax highlighting

javascript

// JavaScript code block
function greet(name) {
    console.log(`Hello, ${name}!`);
}

python

# Python code block
def fibonacci(n):
    if n <= 1:
        return n
    return fibonacci(n-1) + fibonacci(n-2)

sql

-- SQL code block
SELECT id, name, email
FROM users
WHERE active = 1;

Terraform Code with Line Highlighting

terraform

resource "azurerm_resource_group" "vending-identity" {
  name     = var.management_vending_settings.user_assigned_resource_group_name
  location = var.management_vending_settings.location
  tags     = var.tags
}

resource "azurerm_user_assigned_identity" "vending-uai" {
  for_each = local.federated_credentials

  location            = azurerm_resource_group.vending-identity.location
  resource_group_name = azurerm_resource_group.vending-identity.name
  name                = each.value.name
  tags                = var.tags
}

resource "azurerm_federated_identity_credential" "vending-uai" {
  for_each = merge([
    for key, identity in local.federated_credentials : {
      for credential in identity.credentials : credential.name => {
        name    = credential.name
        step    = credential.workflow_step
        subject = credential.subject
      }
    }
  ]...)

  name                = each.value.name
  resource_group_name = azurerm_resource_group.vending-identity.name
  audience            = ["api://AzureADTokenExchange"]
  issuer              = "https://token.actions.githubusercontent.com"
  parent_id           = azurerm_user_assigned_identity.vending-uai[each.value.step].id
  subject             = each.value.subject
}

Tables

Simple Table

Header 1	Header 2	Header 3
Cell 1	Cell 2	Cell 3
Cell 4	Cell 5	Cell 6

Table with Alignment

Left Aligned	Center Aligned	Right Aligned
Left	Center	Right
Text	Text	Text
More	More	More

Table with Complex Content

Feature	Markdown	Markdown Extra
Bold	✓	✓
Italic	✓	✓
Code	✓	✓
Strike	✓	✓
Tables	✓	✓
Footnotes	✗	✓

Blockquotes

This is a simple blockquote.

This is a blockquote that spans multiple lines.

Blockquote with header

This blockquote contains other markdown elements:

• List item 1
• List item 2

Bold text in blockquote.

Level 1 quote

Level 2 nested quote

Level 3 nested quote

Horizontal Rules

---

---

---

---

---

HTML Elements

HTML elements can be used in markdown.

Bold HTML and italic HTML.

Collapsible section

This content is hidden by default and can be expanded.

• Hidden list item 1
• Hidden list item 2

Ctrl + C to copy

Highlighted text with HTML

Markdown Extra Features

Footnotes

This text has a footnote¹.

Another footnote reference².

Abbreviations

The HTML and CSS specifications are maintained by W3C.

Special Attributes

Headers with IDs

Emphasis with Classes

Links with Attributes

Link with attributes

Math (if supported)

Inline math: $E = mc^2$

Block math: $$ \int_{-\infty}^{\infty} e^{-x2} dx = \sqrt{\pi} $$

Mermaid Diagrams (if supported)

graph TD
    A[Start] --> B{Decision}
    B -->|Yes| C[Process 1]
    B -->|No| D[Process 2]
    C --> E[End]
    D --> E
linkStyle default stroke: white

Emoji (if supported)

🙂 🥳 👍 🚀 🌟

Special Characters and Escaping

*Not italic*

`Not code`

\Backslash

# Not a header

Line Breaks

This line ends with two spaces
And this is a new line.

This line ends with a backslash
And this is also a new line.

---

This comprehensive demo showcases the full range of markdown and markdown extra capabilities.

Footnotes

1. This is the first footnote. ↩

2. This is another footnote with a custom name. ↩