aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc/develop.txt
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2022-10-09 19:40:04 -0400
committerGitHub <noreply@github.com>2022-10-09 19:40:04 -0400
commit9d0ed754d5a8e6b442e1da2a153422dcee9004e1 (patch)
tree6ede7f61e4f5deeaaabe31d5bd04ca5dd6959513 /runtime/doc/develop.txt
parent30104695629e11e98050d9762e12285bec44637e (diff)
parent6b01e9bf872cc91530b41fcd97c6bf984776ade6 (diff)
downloadrneovim-9d0ed754d5a8e6b442e1da2a153422dcee9004e1.tar.gz
rneovim-9d0ed754d5a8e6b442e1da2a153422dcee9004e1.tar.bz2
rneovim-9d0ed754d5a8e6b442e1da2a153422dcee9004e1.zip
Merge #20558 feat(docs-html): fixes; ToC tags
Diffstat (limited to 'runtime/doc/develop.txt')
-rw-r--r--runtime/doc/develop.txt3
1 files changed, 3 insertions, 0 deletions
diff --git a/runtime/doc/develop.txt b/runtime/doc/develop.txt
index 14b66a0736..1ba6ae757b 100644
--- a/runtime/doc/develop.txt
+++ b/runtime/doc/develop.txt
@@ -164,6 +164,9 @@ Strict "vimdoc" subset:
that you don't want auto-wrapped. Lists are always rendered with "flow"
(soft-wrapped) layout instead of preformatted (hard-wrapped) layout common
in legacy :help docs.
+ - Limitation: currently the parser https://github.com/neovim/tree-sitter-vimdoc
+ does not understand numbered listitems, so use a bullet symbol (- or •)
+ before numbered items, e.g. "- 1." instead of "1.".
- Separate blocks (paragraphs) of content by a blank line(s).
- Do not use indentation in random places—that prevents the page from using
"flow" layout. If you need a preformatted section, put it in