Skip to content

Commit 83dddfe

Browse files
committed
docs(doc/neorg.norg): update basic markup
1 parent 6a30138 commit 83dddfe

File tree

1 file changed

+16
-15
lines changed

1 file changed

+16
-15
lines changed

doc/neorg.norg

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,20 @@
1515

1616
** Basic Markup
1717
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|
2929

3030
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 `\||)|
3132

3233
** Things which you can nest
3334
Neorg generally does *NOT* care about indentation! 🎉
@@ -63,10 +64,10 @@
6364
- [ ] Undone -> not done yet
6465
- [x] Done -> done with that
6566
- [?] Needs further input
66-
67+
6768
- [!] Urgent -> high priority task
6869
- [+] Recurring task with children
69-
70+
7071
- [-] Pending -> currently in progress
7172
- [=] Task put on hold
7273
- [_] Task cancelled (put down)
@@ -189,7 +190,7 @@
189190
*** Anchors
190191
@code norg
191192
A link to [our website].
192-
193+
193194
[our website]{https://github.com/nvim-neorg/neorg}
194195
@end
195196
The standalone link /text/ is called an *anchor declaration*.
@@ -279,7 +280,7 @@
279280
This will render as:
280281
@code
281282
2. First entry
282-
283+
283284
4. Second entry
284285
@end
285286

0 commit comments

Comments
 (0)