git.iko.soy/typeable/pandoc
on master help sign in
Added a note about the need for `-s` to include YAML in Markdown output.

Closes #1715. Thanks to @nichtich for the suggestion.

commitd009646de7b5795cd5985ba0a5fe70e5b2c57df6 authorJohn MacFarlane <jgm@berkeley.edu> dateMon 15 Dec 2014, 09:20 (12 years ago) parenta864e9a
1 file changed+5
README+5
README+5
@@ -1953,6 +1953,11 @@ A document may contain multiple metadata blocks. The metadata fields will
19531953be combined through a *left-biased union*: if two metadata blocks attempt
19541954to set the same field, the value from the first block will be taken.
19551955
1956+When pandoc is used with `-t markdown` to create a markdown document,
1957+a YAML metadata block will be produced only if the `-s/--standalone`
1958+option is used. All of the metadata will appear in a single block
1959+at the beginning of the document.
1960+
19561961Note that YAML escaping rules must be followed. Thus, for example,
19571962if a title contains a colon, it must be quoted. The pipe character
19581963(`|`) can be used to begin an indented block that will be interpreted