|
15 | 15 |
|
16 | 16 | ** Basic Markup
|
17 | 17 | Here is how you can do very basic markup. First you see it raw, then rendered:
|
18 |
| - - \*bold\*: *bold* |
19 |
| - - \/italic\/: /italic/ |
20 |
| - - \_underline\_: _underline_ |
21 |
| - - \-strikethrough\-: -strikethrough- |
22 |
| - - \|spoiler\|: |spoiler| |
23 |
| - - \`inline code\`: `inline code` |
24 |
| - - \^superscript\^: ^superscript^ | cannot exist within a subscript block |
25 |
| - - \,subscript\,: ,subscript, | cannot exist within a superscript block |
26 |
| - - \$inline math\$: $f(x) = y$ (see also {# Math}) |
27 |
| - - \=variable\=: =variable= (see also {# Variables}) |
28 |
| - - \+inline comment\+: +inline comment+ |
| 18 | + - \*bold\|: *bold| |
| 19 | + - \/italic\|: /italic| |
| 20 | + - \_underline\|: _underline| |
| 21 | + - \-strikethrough\|: -strikethrough| |
| 22 | + - \~spoiler\|: ~spoiler| |
| 23 | + - \`inline code\|: `inline code| |
| 24 | + - \^superscript\|: ^superscript| | cannot exist within a subscript block |
| 25 | + - \,subscript\|: ,subscript| | cannot exist within a superscript block |
| 26 | + - \$inline math\|: $f(x) = y| (see also {# Math}) |
| 27 | + - \=variable\|: =variable| (see also {# Variables}) |
| 28 | + - \+inline comment\|: +inline comment| |
29 | 29 |
|
30 | 30 | This also immediately shows you how to escape a special character using the backslash, \\.
|
| 31 | + +TODO: Discuss the new rules used of attached modifier (i.e. ending them with `\||)| |
31 | 32 |
|
32 | 33 | ** Things which you can nest
|
33 | 34 | Neorg generally does *NOT* care about indentation! 🎉
|
|
63 | 64 | - [ ] Undone -> not done yet
|
64 | 65 | - [x] Done -> done with that
|
65 | 66 | - [?] Needs further input
|
66 |
| - |
| 67 | + |
67 | 68 | - [!] Urgent -> high priority task
|
68 | 69 | - [+] Recurring task with children
|
69 |
| - |
| 70 | + |
70 | 71 | - [-] Pending -> currently in progress
|
71 | 72 | - [=] Task put on hold
|
72 | 73 | - [_] Task cancelled (put down)
|
|
189 | 190 | *** Anchors
|
190 | 191 | @code norg
|
191 | 192 | A link to [our website].
|
192 |
| - |
| 193 | + |
193 | 194 | [our website]{https://github.com/nvim-neorg/neorg}
|
194 | 195 | @end
|
195 | 196 | The standalone link /text/ is called an *anchor declaration*.
|
|
279 | 280 | This will render as:
|
280 | 281 | @code
|
281 | 282 | 2. First entry
|
282 |
| - |
| 283 | + |
283 | 284 | 4. Second entry
|
284 | 285 | @end
|
285 | 286 |
|
|
0 commit comments