Skip to content

Commit

Permalink
fix(:h neorg): remove |example blocks until parser is fixed
Browse files Browse the repository at this point in the history
  • Loading branch information
vhyrro committed Jul 23, 2024
1 parent 08277bb commit a93190d
Showing 1 changed file with 3 additions and 23 deletions.
26 changes: 3 additions & 23 deletions doc/neorg.norg
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,6 @@ version: 0.1

*** Unordered lists

|example
- Unordered list level 1
-- Unordered list level 2
|end

- Unordered list level 1
-- Unordered list level 2
--- Unordered list level 3
Expand All @@ -64,20 +59,15 @@ version: 0.1

*** Ordered lists

|example
~ Ordered list level 1
~~ Ordered list level 2
~~~ Ordered list level 3
~~~~ Ordered list level 4
~~~~~ Ordered list level 5
~~~~~~ Ordered list level 6
|end

*NOTE: For proper ordered list rendering ensure you are running Neovim >= `0.10.0`*

*** Tasks

|example
- ( ) Undone -> not done yet
- (x) Done -> done with that
- (?) Needs further input
Expand All @@ -88,17 +78,12 @@ version: 0.1
- (-) Pending -> currently in progress
- (=) Task put on hold
- (_) Task cancelled (put down)
|end

The task modifier can be placed on any detached modifier, including
headings, definitions, footnotes etc. to track their state.

*** Quotes

|example
> 1. level quote
>> 2. level quote
|end
> 1. level quote
>> 2. level quote
>>> 3. level quote
Expand Down Expand Up @@ -238,7 +223,7 @@ version: 0.1

*** Multi-paragraph definitions

$$ Object to be defined
$$ Term
Here, I can place any number of paragraphs or other format objects.

Even a code example:
Expand All @@ -258,8 +243,7 @@ version: 0.1
^ This is the title of my footnote. I can use this as a link target.
This is the actual footnote content.

This is no longer part of the {^ This is the title of my footnote. I can use this as a link
target}[footnote].
This is no longer part of the footnote.

*** Multi-paragraph footnotes

Expand Down Expand Up @@ -355,11 +339,7 @@ version: 0.1

Note: You can:*not* combine sub- and superscripts like so:

^,This should be super- and subscript.,^ - why though?

You will notice that this gets highlighted as an error:

^,This should be super- and subscript.,^
^,This should be super- and subscript.,^ - gets highlighted as an error.

*** Variables

Expand Down

0 comments on commit a93190d

Please sign in to comment.