Permalink
Browse files

explain the role of top-level H1 headings

  • Loading branch information...
1 parent 475797b commit 1c3324b2dbd764b0ac27f2bdf9dfa7bc47ffa8b9 @sunaku committed Dec 7, 2011
Showing with 6 additions and 0 deletions.
  1. +3 −0 README.markdown
  2. +3 −0 bin/md2man
View
@@ -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.
View
@@ -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.

0 comments on commit 1c3324b

Please sign in to comment.