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

Improve documentation of horizontal rules and YAML metadata.

Browse source 
Horizontal rules should have blank space after them, or
pandoc may interpret them as beginning a YAML metadata
block or table.

Closes #8140.
This commit is contained in:
John MacFarlane 2022-06-22 10:21:56 -07:00
parent e7269beeb6
commit e0dea96d6c
1 changed files with 13 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
MANUAL.txt
View file

@ -4212,6 +4212,10 @@ A line containing a row of three or more `*`, `-`, or `_` characters
---------------
We strongly recommend that horizontal rules be separated from
surrounding text by blank lines. If a horizontal rule is not
followed by a blank line, pandoc may try to interpret the
lines that follow as a YAML metadata block or a table.
## Tables
@ -4520,16 +4524,19 @@ will also have "Version 4.0" in the header.
A [YAML] metadata block is a valid YAML object, delimited by a line of three
hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
(`...`) at the bottom. A YAML metadata block may occur anywhere in the
document, but if it is not at the beginning, it must be preceded by a blank
line. (Note that, because of the way pandoc concatenates input files when
several are provided, you may also keep the metadata in a separate YAML file
and pass it to pandoc as an argument, along with your Markdown files:
(`...`) at the bottom. The initial line `---` must not be followed by a blank
line. A YAML metadata block may occur anywhere in the document, but if
it is not at the beginning, it must be preceded by a blank line.
Note that, because of the way pandoc concatenates input files
when several are provided, you may also keep the metadata in a
separate YAML file and pass it to pandoc as an argument, along
with your Markdown files:
pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
Just be sure that the YAML file begins with `---` and ends with `---` or
`...`.) Alternatively, you can use the `--metadata-file` option. Using
`...`. Alternatively, you can use the `--metadata-file` option. Using
that approach however, you cannot reference content (like footnotes)
from the main markdown input document.