Markdown Reference
Markdown Reference
Automatically generate table of contents by checking the option here: Settings > Format > Markdown
.
H2 Header
H3 header
H4 Header
H5 Header
H6 Header
Format Text
Italic emphasis , Alternative italic emphasis
Bold emphasis , Alternative bold emphasis
Strikethrough
Break line (two spaces at end of line)
Block quote
Inline code
1
2
3
Code blocks
are
awesome
Lists
Ordered & unordered
- Unordered list
- …with asterisk/star
-
Test
- Another unordered list
- …with hyphen/minus
- Test
- Ordered list
- Test
- Test
- Test
- Nested lists
- Unordered nested list
- Test
- Test
- Test
- Ordered nested list
- Test
- Test
- Test
- Test
- Double-nested unordered list
- Test
- Unordered
- Test a
- Test b
- Ordered
- Test 1
- Test 2
Checklist
- Salad
- Potatoes
- Clean
- Cook
Links
Tables
Left aligned | Middle aligned | Right aligned |
---|---|---|
Test | Test | Test |
Test | Test | Test |
÷÷÷÷
Shorter | Table | Syntax |
---|---|---|
Test | Test | Test |
Test | Test | Test |
Math (KaTeX)
See reference & examples. Enable by checking Math at Settings > Markdown
.
Math inline
$ I = \frac V R $
Math block
\[\begin{array}{c} abla \times \vec{\mathbf{B}} -\, \frac1c\, \frac{\partial\vec{\mathbf{E}}}{\partial t} & = \frac{4\pi}{c}\vec{\mathbf{j}} abla \cdot \vec{\mathbf{E}} & = 4 \pi \rho \\ abla \times \vec{\mathbf{E}}\, +\, \frac1c\, \frac{\partial\vec{\mathbf{B}}}{\partial t} & = \vec{\mathbf{0}} \\ abla \cdot \vec{\mathbf{B}} & = 0 \end{array}\] \[\frac{k_t}{k_e} = \sqrt{2}\]Format Text (continued)
Text color
Text with background color / highlight
Text foreground color
Text with colored outline / Text with colored outline
Text sub & superscript
Underline
The Subway sandwich was super
Super special characters: ⁰ ¹ ² ³ ⁴ ⁵ ⁶ ⁷ ⁸ ⁹ ⁺ ⁻ ⁼ ⁽ ⁾ ⁿ ™ ® ℠
Text positioning
text on the right
text in the center
(one empy line above and below
required for Markdown support OR markdown=’1’)
Block Text
lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum.
Dropdown
Click to Expand/Collapse
Expanded content. Shows up and keeps visible when clicking expand. Hide again by clicking the dropdown button again.
Break page
To break the page (/start a new page), put the div below into a own line. Relevant for creating printable pages from the document (Print / PDF).
Multimedia
Images
Videos
Peertube Road in the wood
Audio & Music
Web audio Guifrog - Xia Yu
Charts / Graphs / Diagrams (mermaidjs)
Pie, flow, sequence, class, state, ER
See also: mermaidjs live editor.
graph LR
A[Square Rect] -- Link text --> B((Circle))
A --> C(Round Rect)
B --> D{Rhombus}
C --> D
Admonition Extension
Create block-styled side content.
Use one of these qualifiers to select the icon and the block color: abstract, summary, tldr, bug, danger, error, example, snippet, failure, fail, missing, question, help, faq, info, todo, note, seealso, quote, cite, success, check, done, tip, hint, important, warning, caution, attention.
!!! warning ‘Optional Title’ Block-Styled Side Content with Markdown support
!!! info ‘’ No-Heading Content
??? bug ‘Collapsed by default’ Collapsible Block-Styled Side Content
???+ example ‘Open by default’ Collapsible Block-Styled Side Content
This Markdown reference file was created for the Markor project by Gregor Santner and is licensed Creative Commons Zero 1.0 (public domain). File revision 3.
Comments powered by Disqus.