aboutsummaryrefslogtreecommitdiff
path: root/MANUAL.txt
diff options
context:
space:
mode:
authormb21 <mb21@users.noreply.github.com>2018-03-30 21:48:14 +0200
committermb21 <mb21@users.noreply.github.com>2018-09-15 16:48:04 +0200
commit6aa5fcac13ea702de19ee1a605631e3ac75d7e05 (patch)
treeaedc06346c0dd697077c3867862947506d2bccd5 /MANUAL.txt
parent73fa70c3974fa37aeb9a9d1535c1e09fb549bbcf (diff)
downloadpandoc-6aa5fcac13ea702de19ee1a605631e3ac75d7e05.tar.gz
introduce --metadata-file option
closes #1960 API change: Text.Pandoc.Readers.Markdown exports now `yamlToMeta`
Diffstat (limited to 'MANUAL.txt')
-rw-r--r--MANUAL.txt14
1 files changed, 13 insertions, 1 deletions
diff --git a/MANUAL.txt b/MANUAL.txt
index b4033a5e3..2eda67cc4 100644
--- a/MANUAL.txt
+++ b/MANUAL.txt
@@ -578,6 +578,16 @@ Reader options
printed in some output formats) and metadata values will be escaped
when inserted into the template.
+`--metadata-file=`*FILE*
+
+: Read metadata from the supplied YAML (or JSON) file.
+ This option can be used with every input format, but string
+ scalars in the YAML file will always be parsed as Markdown.
+ Generally, the input will be handled the same as in
+ [YAML metadata blocks][Extension: `yaml_metadata_block`].
+ Metadata values specified inside the document, or by using `-M`,
+ overwrite values specified with this option.
+
`-p`, `--preserve-tabs`
: Preserve tabs instead of converting them to spaces (the default).
@@ -3061,7 +3071,9 @@ 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
+that approach however, you cannot reference content (like footnotes)
+from the main markdown input document.
Metadata will be taken from the fields of the YAML object and added to any
existing document metadata. Metadata can contain lists and objects (nested