aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorJohn MacFarlane <jgm@berkeley.edu>2014-07-10 13:49:40 -0700
committerJohn MacFarlane <jgm@berkeley.edu>2014-07-10 13:49:40 -0700
commitca159de30a2b3653ce668799a168993b5a2ca76d (patch)
treef332ba88eca922eaac0f86e79078ddcef54ae80b /README
parent66378062b622b0815a1a2ddce5d557e3ad13330c (diff)
downloadpandoc-ca159de30a2b3653ce668799a168993b5a2ca76d.tar.gz
Documented fact that you can put YAML metadata in a separate file.
See #1412.
Diffstat (limited to 'README')
-rw-r--r--README9
1 files changed, 8 insertions, 1 deletions
diff --git a/README b/README
index 35e5b0504..bb690f779 100644
--- a/README
+++ b/README
@@ -1842,7 +1842,14 @@ 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.
+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
+`...`.)
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