Tissevert/pandoc
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

Added a note about the need for -s to include YAML in Markdown output.

Browse source 
Closes #1715. Thanks to @nichtich for the suggestion.
This commit is contained in:
John MacFarlane 2014-12-15 09:20:03 -08:00
parent a864e9a348
commit d009646de7
1 changed files with 5 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
README
View file

@ -1953,6 +1953,11 @@ A document may contain multiple metadata blocks. The metadata fields will
be combined through a *left-biased union*: if two metadata blocks attempt
to set the same field, the value from the first block will be taken.
When pandoc is used with `-t markdown` to create a markdown document,
a YAML metadata block will be produced only if the `-s/--standalone`
option is used. All of the metadata will appear in a single block
at the beginning of the document.
Note that YAML escaping rules must be followed. Thus, for example,
if a title contains a colon, it must be quoted. The pipe character
(`|`) can be used to begin an indented block that will be interpreted