|
| 1 | +# Markdown Reference |
| 2 | +Automatically generate _table of contents_ by checking the option here: `Settings > Format > Markdown`. |
| 3 | + |
| 4 | +## H2 Header |
| 5 | +### H3 header |
| 6 | +#### H4 Header |
| 7 | +##### H5 Header |
| 8 | +###### H6 Header |
| 9 | + |
| 10 | +<!-- --------------- --> |
| 11 | + |
| 12 | +## Format Text |
| 13 | + |
| 14 | +*Italic emphasis* , _Alternative italic emphasis_ |
| 15 | + |
| 16 | +**Bold emphasis** , __Alternative bold emphasis__ |
| 17 | + |
| 18 | +~~Strikethrough~~ |
| 19 | + |
| 20 | +Break line (two spaces at end of line) |
| 21 | + |
| 22 | +> Block quote |
| 23 | +
|
| 24 | +`Inline code` |
| 25 | + |
| 26 | +``` |
| 27 | +Code blocks |
| 28 | +are |
| 29 | +awesome |
| 30 | +``` |
| 31 | + |
| 32 | +<!-- --------------- --> |
| 33 | + |
| 34 | +## Lists |
| 35 | +### Ordered & unordered |
| 36 | + |
| 37 | +* Unordered list |
| 38 | +* ...with asterisk/star |
| 39 | +* Test |
| 40 | + |
| 41 | +- Another unordered list |
| 42 | +- ...with hyphen/minus |
| 43 | +- Test |
| 44 | + |
| 45 | +1. Ordered list |
| 46 | +2. Test |
| 47 | +3. Test |
| 48 | +4. Test |
| 49 | + |
| 50 | +- Nested lists |
| 51 | + * Unordered nested list |
| 52 | + * Test |
| 53 | + * Test |
| 54 | + * Test |
| 55 | +- Ordered nested list |
| 56 | + 1. Test |
| 57 | + 2. Test |
| 58 | + 3. Test |
| 59 | + 4. Test |
| 60 | +- Double-nested unordered list |
| 61 | + - Test |
| 62 | + - Unordered |
| 63 | + - Test a |
| 64 | + - Test b |
| 65 | + - Ordered |
| 66 | + 1. Test 1 |
| 67 | + 2. Test 2 |
| 68 | + |
| 69 | +### Checklist |
| 70 | +* [ ] Salad |
| 71 | +* [x] Potatoes |
| 72 | + |
| 73 | +1. [x] Clean |
| 74 | +2. [ ] Cook |
| 75 | + |
| 76 | +<!-- --------------- --> |
| 77 | + |
| 78 | +## Links |
| 79 | +[Link](https://duckduckgo.com/) |
| 80 | + |
| 81 | +[File in same folder as the document.](markor-markdown-reference.md) Use %20 for spaces! |
| 82 | + |
| 83 | +<!-- --------------- --> |
| 84 | + |
| 85 | +## Tables |
| 86 | + |
| 87 | +| Left aligned | Middle aligned | Right aligned | |
| 88 | +| :--------------- | :------------------: | -----------------: | |
| 89 | +| Test | Test | Test | |
| 90 | +| Test | Test | Test | |
| 91 | + |
| 92 | +÷÷÷÷ |
| 93 | + |
| 94 | +Shorter | Table | Syntax |
| 95 | +:---: | ---: | :--- |
| 96 | +Test | Test | Test |
| 97 | +Test | Test | Test |
| 98 | + |
| 99 | +<!-- Comment: Not visibile in view. Can also span across multiple lines. End with:--> |
| 100 | + |
| 101 | +<!-- ------------- --> |
| 102 | + |
| 103 | +## Math (KaTeX) |
| 104 | +See [reference](https://katex.org/docs/supported.html) & [examples](https://github.com/waylonflinn/markdown-it-katex/blob/master/README.md). Enable by checking Math at `Settings > Markdown`. |
| 105 | + |
| 106 | +### Math inline |
| 107 | + |
| 108 | +$ I = \frac V R $ |
| 109 | + |
| 110 | +### Math block |
| 111 | + |
| 112 | +$$\begin{array}{c} |
| 113 | +abla \times \vec{\mathbf{B}} -\, \frac1c\, \frac{\partial\vec{\mathbf{E}}}{\partial t} & = \frac{4\pi}{c}\vec{\mathbf{j}} |
| 114 | +abla \cdot \vec{\mathbf{E}} & = 4 \pi \rho \\ |
| 115 | +abla \times \vec{\mathbf{E}}\, +\, \frac1c\, \frac{\partial\vec{\mathbf{B}}}{\partial t} & = \vec{\mathbf{0}} \\ |
| 116 | +abla \cdot \vec{\mathbf{B}} & = 0 \end{array}$$ |
| 117 | + |
| 118 | + |
| 119 | +$$\frac{k_t}{k_e} = \sqrt{2}$$ |
| 120 | + |
| 121 | +<!-- ------------- --> |
| 122 | + |
| 123 | +## Format Text (continued) |
| 124 | + |
| 125 | +### Text color |
| 126 | + |
| 127 | +<span style='background-color:#ffcb2e;'>Text with background color / highlight</span> |
| 128 | + |
| 129 | +<span style='color:#3333ff;'>Text foreground color</span> |
| 130 | + |
| 131 | +<span style='text-shadow: 0px 0px 2px #FF0000;'>Text with colored outline</span> / <span style='text-shadow: 0px 0px 2px #0000FF; color: white'>Text with colored outline</span> |
| 132 | + |
| 133 | + |
| 134 | +### Text sub & superscript |
| 135 | + |
| 136 | +<u>Underline</u> |
| 137 | + |
| 138 | +The <sub>Subway</sub> sandwich was <sup>super</sup> |
| 139 | + |
| 140 | +Super special characters: ⁰ ¹ ² ³ ⁴ ⁵ ⁶ ⁷ ⁸ ⁹ ⁺ ⁻ ⁼ ⁽ ⁾ ⁿ ™ ® ℠ |
| 141 | + |
| 142 | +### Text positioning |
| 143 | +<div markdown='1' align='right'> |
| 144 | + |
| 145 | +text on the **right** |
| 146 | + |
| 147 | +</div> |
| 148 | + |
| 149 | +<div markdown='1' align='center'> |
| 150 | + |
| 151 | +text in the **center** |
| 152 | +(one empy line above and below |
| 153 | +required for Markdown support OR markdown='1') |
| 154 | + |
| 155 | +</div> |
| 156 | + |
| 157 | +### Block Text |
| 158 | + |
| 159 | +<div markdown='1' style='text-align: justify; text-justify: inter-word;'> |
| 160 | +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. |
| 161 | +</div> |
| 162 | + |
| 163 | +### Dropdown |
| 164 | + |
| 165 | +<details markdown='1'><summary>Click to Expand/Collapse</summary> |
| 166 | + |
| 167 | +Expanded content. Shows up and keeps visible when clicking expand. Hide again by clicking the dropdown button again. |
| 168 | + |
| 169 | +</details> |
| 170 | + |
| 171 | + |
| 172 | +### Break page |
| 173 | +To break the page (/start a new page), put the div below into a own line. |
| 174 | +Relevant for creating printable pages from the document (Print / PDF). |
| 175 | + |
| 176 | +<div style='page-break-after: always'></div> |
| 177 | + |
| 178 | + |
| 179 | +<!-- ------------- --> |
| 180 | + |
| 181 | +## Multimedia |
| 182 | + |
| 183 | +### Images |
| 184 | + |
| 185 | + |
| 186 | +### Videos |
| 187 | +**Youtube** [Welcome to Upper Austria](https://www.youtube.com/watch?v=RJREFH7Lmm8) |
| 188 | +<iframe width='360' height='200' src='https://www.youtube.com/embed/RJREFH7Lmm8'> </iframe> |
| 189 | + |
| 190 | +**Peertube** [Road in the wood](https://open.tube/videos/watch/8116312a-dbbd-43a3-9260-9ea6367c72fc) |
| 191 | +<div><video controls><source src='https://peertube.mastodon.host/download/videos/8116312a-dbbd-43a3-9260-9ea6367c72fc-480.mp4' </source></video></div> |
| 192 | + |
| 193 | +<!-- **Local video** <div><video controls><source src='voice-parrot.mp4' </source></video></div> --> |
| 194 | + |
| 195 | +### Audio & Music |
| 196 | +**Web audio** [Guifrog - Xia Yu](https://www.freemusicarchive.org/music/Guifrog/Xia_Yu) |
| 197 | +<audio controls src='https://files.freemusicarchive.org/storage-freemusicarchive-org/music/ccCommunity/Guifrog/Xia_Yu/Guifrog_-_Xia_Yu.mp3'></audio> |
| 198 | + |
| 199 | +**Local audio** Yellowcard - Lights up in the sky |
| 200 | +<audio controls src='../Music/mp3/Yellowcard/[2007]%20Paper%20Walls/Yellowcard%20-%2005%20-%20Light%20Up%20the%20Sky.mp3'></audio> |
| 201 | + |
| 202 | +## Charts / Graphs / Diagrams (mermaidjs) |
| 203 | +Pie, flow, sequence, class, state, ER |
| 204 | +See also: mermaidjs [live editor](https://mermaid-js.github.io/mermaid-live-editor/). |
| 205 | + |
| 206 | +```mermaid |
| 207 | +graph LR |
| 208 | + A[Square Rect] -- Link text --> B((Circle)) |
| 209 | + A --> C(Round Rect) |
| 210 | + B --> D{Rhombus} |
| 211 | + C --> D |
| 212 | +``` |
| 213 | + |
| 214 | + |
| 215 | + |
| 216 | +## Admonition Extension |
| 217 | +Create block-styled side content. |
| 218 | +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. |
| 219 | + |
| 220 | +!!! warning 'Optional Title' |
| 221 | + Block-Styled Side Content with **Markdown support** |
| 222 | + |
| 223 | +!!! info '' |
| 224 | + No-Heading Content |
| 225 | + |
| 226 | +??? bug 'Collapsed by default' |
| 227 | + Collapsible Block-Styled Side Content |
| 228 | + |
| 229 | +???+ example 'Open by default' |
| 230 | + Collapsible Block-Styled Side Content |
| 231 | + |
| 232 | +------------------ |
| 233 | + |
| 234 | +This Markdown reference file was created for the [Markor](https://github.com/gsantner/markor) project by [Gregor Santner](https://github.com/gsanter) and is licensed [Creative Commons Zero 1.0](https://creativecommons.org/publicdomain/zero/1.0/legalcode) (public domain). File revision 3. |
| 235 | + |
| 236 | +------------------ |
| 237 | + |
0 commit comments