@@ -32,6 +32,7 @@ Overview
3232 nature; parsing the contents would require loading a "child" language
3333 (injection). See [ #2 ] ( https://github.com/neovim/tree-sitter-vimdoc/issues/2 ) .
3434 - the terminating ` < ` (and any following whitespace) is discarded (anonymous).
35+ - ` url ` intentionally does not capture ` .,) ` at the end of the URL. See also [ Known issues] ( #known-issues ) .
3536- ` h1 ` = "Heading 1": ` ====== ` followed by text and optional ` *tags* ` .
3637- ` h2 ` = "Heading 2": ` ------ ` followed by text and optional ` *tags* ` .
3738- ` h3 ` = "Heading 3": UPPERCASE WORDS, followed by optional ` *tags* ` , followed
@@ -45,8 +46,11 @@ Known issues
4546- Spec requires that ` codeblock ` delimiter ">" must be preceded by a space
4647 (" >"), not a tab. But currently the grammar doesn't enforce this. Example:
4748 ` :help lcs-tab ` .
48- - ` url ` doesn't handle _ surrounding_ parens. E.g. ` (https://example.com/#yay) ` yields ` word `
49- - ` url ` doesn't handle _ nested_ parens. E.g. ` (https://example.com/(foo)#yay) `
49+ - ` url ` cannot contain a closing bracket ` ] ` anywhere in the URL. (Workaround:
50+ URL-encode the bracket.) This is a tradeoff so that markdown hyperlinks work:
51+ ```
52+ [https://example.com](https://example.com)
53+ ```
5054- ` column_heading ` currently only recognizes tilde ` ~ ` preceded by space (i.e.
5155 ` foo ~ ` not ` foo~ ` ). This covers 99% of : help files.
5256- ` column_heading ` children should be plaintext, but currently are parsed as ` $._atom ` .
@@ -55,8 +59,8 @@ Known issues
5559TODO
5660----
5761
58- - ` tag_heading ` : line(s) containing only tags, typically implies a "heading"
59- before a block .
62+ - ` h4 ` ("tag heading") : a line containing only tags, or ending with a tag, is
63+ a "h4" heading .
6064
6165Release
6266-------
0 commit comments