README: note level 4 heading issues
authorThomas Lamprecht <t.lamprecht@proxmox.com>
Wed, 14 Nov 2018 07:08:01 +0000 (08:08 +0100)
committerThomas Lamprecht <t.lamprecht@proxmox.com>
Wed, 14 Nov 2018 07:08:54 +0000 (08:08 +0100)
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
README.adoc

index e95a116..43ce69f 100644 (file)
@@ -96,6 +96,10 @@ below the title text:
  Level 3:                 ^^^^^^^^^^^^^^^^^^^^^^
  Level 4 (bottom level):  ++++++++++++++++++++++
 
+NOTE: Level 4 headings are currently not working for `manpage` outputs, you may
+want to use `.SECTION' instead, which results in the same rendering, and this
+level of Heading isn't displayed in any Index/TOC anyway.
+
 Section titles should always be preceded by two empty lines. Each word
 in a title should be capitalized except for ``articles, coordinating
 conjunctions, prepositions, and the word to in infinitives unless they