explain the role of top-level H1 headings

sunaku · Dec 7, 2011 · 1c3324b · 1c3324b
1 parent 475797b
commit 1c3324b
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/README.markdown b/README.markdown
@@ -74,6 +74,9 @@ Document Format
 
 md2man attaches the following additional semantics to its [Markdown] input:
 
+  * There can be at most one top-level heading (H1).  It is emitted as `.TH`
+    in the [Roff] output, specifying the UNIX man page's header and footer.
+
   * Paragraphs whose lines are all uniformly indented by two spaces are
     considered to be "indented paragraphs".  They are unindented accordingly
     before emission as `.IP` in the [Roff] output.

diff --git a/bin/md2man b/bin/md2man
@@ -25,6 +25,9 @@ If *FILE* is not given, then the standard input stream is read in its place.
 
 This program attaches the following additional semantics to markdown(7):
 
+  * There can be at most one top-level heading (H1).  It is emitted as `.TH`
+    in the roff(7) output, specifying the UNIX man page's header and footer.
+
   * Paragraphs whose lines are all uniformly indented by two spaces are
     considered to be "indented paragraphs".  They are unindented accordingly
     before emission as `.IP` in the roff(7) output.