Skip to content

Formatting

Paragraphs

Text not separated by a blank line will be grouped together as if they were a single paragraph. an

For ease of editing for future editors, please put each sentence on a separate line when writing a document.

source:

This is a sentence.
This sentence follows that sentence.
This sentence is also part of the same paragraph.

This sentence is starts new paragraph.
There is a blank line between this paragraph and the previous one.
This sentence concludes the paragraph.

result:

This is a sentence. This sentence follows that sentence. This sentence is also part of the same paragraph.

This sentence is starts new paragraph. There is a blank line between this paragraph and the previous one. This sentence concludes the paragraph.

Headings

element syntax
level 1 heading # level 1 heading
level 2 heading ## level 2 heading
level 3 heading ### level 3 heading
level 4 heading #### level 4 heading
etc. ...

Basic Formatting

element syntax result
bold **bold** bold
italic *italic** italic
verbatim (inline code) `code` code

pythhon-markdown Extended Syntax

element syntax result
highlight ==highlight== highlight
underline ^^underline^^ underline
strikethrough ~~strikethrough~~ strikethrough
subscript sub~script~ subscript
superscript super^script^ superscript
keyboard ++enter++ Enter

Lists

ordered lists

ordered lists are denoted by a group of lines where each line starts out with a number and a period. markdown will automatically publish the correct number order even if the raw input is out of order.

syntax: 

1. item 1
8. item 2
3. item 3

result:

  1. item 1
  2. item 2
  3. item 3

unordered list

syntax: 

- an item
- another item
- an other item
- another other item
result:

  • an item
  • another item
  • an other item
  • another other item

mkdocs-material Extensions