aboutsummaryrefslogtreecommitdiff
path: root/MANUAL.txt
diff options
context:
space:
mode:
authorJohn MacFarlane <jgm@berkeley.edu>2018-09-15 14:32:06 -0700
committerGitHub <noreply@github.com>2018-09-15 14:32:06 -0700
commit6bd8037b8dc3a6e9d820d412d23fff99ec0c21a6 (patch)
treea58c10319121ad847f1c39e0c22cee9863fbfb70 /MANUAL.txt
parentf736dea4ba71f81b37ff28a218115871249b35ec (diff)
parent5347e9454fae70cd2b534ad8e3c02d1cea8c2d93 (diff)
downloadpandoc-6bd8037b8dc3a6e9d820d412d23fff99ec0c21a6.tar.gz
Merge pull request #4604 from mb21/yaml-file
Introduce --metadata-file option
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 ddd849850..ecb2bcb2c 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