Heading 1¶

Admonitions¶

Possible options¶

note
abstract, summary, tldr
info, todo
tip, hint, important
success, check, done
question, help, faq
warning, caution, attention
failure, fail, missing
danger, error
bug
example
quote, cite

Title

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.

Note

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.

Info

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.

Info

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.

Carret¶

carret external documentation

Insert¶

Insert me

Superscript¶

H²0

text^{a superscript}

Code Blocks¶

codeblocks external documentation

Code block¶

import tensorflow as tf

Code block with title¶

bubble_sort.py

def bubble_sort(items):
    for i in range(len(items)):
        for j in range(len(items) - 1 - i):
            if items[j] > items[j + 1]:
                items[j], items[j + 1] = items[j + 1], items[j]

Code block with line numbers¶

def bubble_sort(items):
    for i in range(len(items)):
        for j in range(len(items) - 1 - i):
            if items[j] > items[j + 1]:
                items[j], items[j + 1] = items[j + 1], items[j]

Code block with highlighting of specific lines¶

def bubble_sort(items):
    for i in range(len(items)):
        for j in range(len(items) - 1 - i):
            if items[j] > items[j + 1]:
                items[j], items[j + 1] = items[j + 1], items[j]

Highlighting inline code blocks¶

The range() function is used to generate a sequence of numbers.

Content tabs¶

contenttabs external documentation

Grouping code blocks¶

CC++

#include <stdio.h>

int main(void) {
  printf("Hello world!\n");
  return 0;
}

#include <iostream>

int main(void) {
  std::cout << "Hello world!" << std::endl;
  return 0;
}

Grouping other content¶

Unordered listOrdered list

Sed sagittis eleifend rutrum
Donec vitae suscipit est
Nulla tempor lobortis orci

Sed sagittis eleifend rutrum
Donec vitae suscipit est
Nulla tempor lobortis orci

Embedded content¶

Example

Unordered ListOrdered List

* Sed sagittis eleifend rutrum
* Donec vitae suscipit est
* Nulla tempor lobortis orci

1. Sed sagittis eleifend rutrum
2. Donec vitae suscipit est
3. Nulla tempor lobortis orci

Critic¶

critic external documentation

Critic Markup Accept¶

Here is some ~~incorrect~~ Markdown. I am adding this here. Here is some more ~~text that I am removing~~text. And here is even more text that I am adding. Paragraph was deleted and replaced with some spaces.

Spaces were removed and a paragraph was added.

And here is a comment on some textThis works quite well. I just wanted to comment on it.. Substitutions isare great!

General block handling.

test remove

test remove

test remove

test remove

test remove

test add
test add
test add
- test add
test add

Data Tables¶

datatables external documentation

Left aligned¶

Method	Description
`GET`	:material-check: Fetch resource
`PUT`	:material-check-all: Update resource
`DELETE`	:material-close: Delete resource

Center aligned¶

Method	Description
`GET`	:material-check: Fetch resource
`PUT`	:material-check-all: Update resource
`DELETE`	:material-close: Delete resource

Right aligned¶

Method	Description
`GET`	:material-check: Fetch resource
`PUT`	:material-check-all: Update resource
`DELETE`	:material-close: Delete resource

Details¶

details external documentation

Details¶

Open styled details

Nested details!

And more content again.

Class from Template¶

Success

Content.

Warning

Content.

Footnotes¶

footnotes external documentation

Footnote references¶

Lorem ipsum¹ dolor sit amet, consectetur adipiscing elit.²

Footnote content¶

Formatting¶

formatting external documentation

Highlighting changes¶

Text can be ~~deleted~~ and replacement text added. This can also be combined into ~~one~~a single operation. Highlighting is also possible and comments can be added inline.

Formatting can also be applied to blocks by putting the opening and closing tags on separate lines and adding new lines between the tags and the content.

Highlighting text¶

This was marked
This was inserted
~~This was deleted~~

Sub- and superscripts¶

H₂O
A^TA

Keyboard keys¶

Ctrl+Alt+Del

Headings¶

Heading 1¶
Heading 2¶
Heading 3¶
Heading 4¶
Heading 5¶

Inline Hilite¶

inlinehilite external documentation

Inline Highlighted Code¶

Here is some code: import pymdownx; pymdownx.__version__.

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

Images¶

images external documentation

Aligned left¶

Aligned right¶

Image caption¶

Image lazy-loading¶

Keys¶

keys external documentation

Keys¶

Ctrl+Alt+Del

Custom Keys¶

Ctrl+Alt+My Special Key

Cmd+Alt+Ü

Lists¶

lists external documentation

Unordered list¶

Nulla et rhoncus turpis. Mauris ultricies elementum leo. Duis efficitur accumsan nibh eu mattis. Vivamus tempus velit eros, porttitor placerat nibh lacinia sed. Aenean in finibus diam.
- Duis mollis est eget nibh volutpat, fermentum aliquet dui mollis.
- Nam vulputate tincidunt fringilla.
- Nullam dignissim ultrices urna non auctor.

Ordered list¶

Vivamus id mi enim. Integer id turpis sapien. Ut condimentum lobortis sagittis. Aliquam purus tellus, faucibus eget urna at, iaculis venenatis nulla. Vivamus a pharetra leo.
1. Vivamus venenatis porttitor tortor sit amet rutrum. Pellentesque aliquet quam enim, eu volutpat urna rutrum a. Nam vehicula nunc mauris, a ultricies libero efficitur sed.
2. Morbi eget dapibus felis. Vivamus venenatis porttitor tortor sit amet rutrum. Pellentesque aliquet quam enim, eu volutpat urna rutrum a.
  1. Mauris dictum mi lacus
  2. Ut sit amet placerat ante
  3. Suspendisse ac eros arcu

Definition list¶

Lorem ipsum dolor sit amet

Sed sagittis eleifend rutrum. Donec vitae suscipit est. Nullam tempus tellus non sem sollicitudin, quis rutrum leo facilisis.

Cras arcu libero

Aliquam metus eros, pretium sed nulla venenatis, faucibus auctor ex. Proin ut eros sed sapien ullamcorper consequat. Nunc ligula ante.

Duis mollis est eget nibh volutpat, fermentum aliquet dui mollis. Nam vulputate tincidunt fringilla. Nullam dignissim ultrices urna non auctor.

Task list¶

Lorem ipsum dolor sit amet, consectetur adipiscing elit
Vestibulum convallis sit amet nisi a tincidunt
- In hac habitasse platea dictumst
- In scelerisque nibh non dolor mollis congue sed et metus
- Praesent sed risus massa
Aenean pretium efficitur erat, donec pharetra, ligula non scelerisque

YouTube video¶

Text styles¶

Bold
The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog.

Italic
The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog.

Bold and Italic
The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog.

Blockquotes

The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog.

The quick brown fox jumps over the lazy dog.

The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog.

The quick brown fox jumps over the lazy dog.

The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog.

Monospaced
The quick brown fox jumps over the lazy dog.

Underlined
The quick brown fox jumps over the lazy dog.

Strike-through
~~The quick brown fox jumps over the lazy dog.~~

Boxed

The quick brown fox jumps over the lazy dog.

Subscript
_{The quick brown fox jumps over the lazy dog.} Superscript
^{The quick brown fox jumps over the lazy dog.}

Code Highlighting

public static String monthNames[] = {"January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"};

public static String monthNames[] = {"January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"};

Link
external documentation

Horizontal Rule¶

Lorem ipsum dolor sit amet, consectetur adipiscing elit. ↩
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. ↩

Admonitions¶

Possible options¶

Carret¶

Insert¶

Superscript¶

Code Blocks¶

Code block¶

Code block with title¶

Code block with line numbers¶

Code block with highlighting of specific lines¶

Highlighting inline code blocks¶

Content tabs¶

Grouping code blocks¶

Grouping other content¶

Embedded content¶

Critic¶

Critic Markup Accept¶

Data Tables¶

Left aligned¶

Center aligned¶

Right aligned¶

Details¶

Details¶

Class from Template¶

Footnotes¶

Footnote references¶

Footnote content¶

Formatting¶

Highlighting changes¶

Highlighting text¶

Sub- and superscripts¶

Keyboard keys¶

Headings¶

Heading 1¶

Heading 2¶

Heading 3¶

Heading 4¶

Heading 5¶

Inline Hilite¶

Inline Highlighted Code¶

Images¶

Aligned left¶

Aligned right¶

Image caption¶

Image lazy-loading¶

Keys¶

Keys¶

Custom Keys¶

Lists¶

Unordered list¶

Ordered list¶

Definition list¶

Task list¶

YouTube video¶

Text styles¶

Horizontal Rule¶