git.iko.soy/typeable/pandoc
on master help sign in
Improve sample --defaults file in MANUAL.txt.
commit34e6464e306d9926f4559156fd144361f0b4efb0 authorJohn MacFarlane <jgm@berkeley.edu> dateFri 11 Oct 2019, 08:57 (7 years ago) parent8a64bd0
1 file changed+113−63
MANUAL.txt+113−63
MANUAL.txt+113−63
@@ -1427,102 +1427,152 @@ of options. Here is a sample defaults file demonstrating all of
14271427the fields that may be used:
14281428
14291429``` yaml
1430−tab-stop: 8
1431−preserve-tabs: yes
1432−standalone: true
1433−table-of-contents: true
1434−# toc is a synonym for table-of-contents
14351430from: markdown+emoji
1436−# reader is a synonym for from
1431+# reader: may be used instead of from:
14371432to: html5
1438−# writer is a synonym for to
1439−shift-heading-level-by: 1
1440−template: leter
1433+# writer: may be used instead of to:
1434+
1435+# leave blank for output to stdout:
1436+output-file:
1437+# leave blank for input from stdin:
1438+input-files:
1439+- preface.md
1440+- content.md
1441+
1442+template: letter
1443+standalone: true
1444+self-contained: false
1445+
1446+# note that structured variables may be specified:
14411447variables:
14421448 documentclass: book
14431449 classoptions:
14441450 - twosides
14451451 - draft
1452+
1453+# metadata values specified here are parsed as literal
1454+# string text, not markdown:
14461455metadata:
14471456 author:
14481457 - Sam Smith
14491458 - Julie Liu
1450−metadata-files: []
1451−# you may also use metadata-file with a single value
1452−output-file: -
1453−input-files:
1454−- preface.md
1455−- content.md
1459+metadata-files:
1460+- boilerplate.yaml
1461+# or you may use metadata-file: with a single value
1462+
1463+# Note that these take files, not their contents:
1464+include-before-body: []
1465+include-after-body: []
1466+include-in-header: []
1467+resource-path: ["."]
1468+
1469+# filters will be assumed to be lua filters if they have
1470+# the .lua extension, and json filters otherwise. But
1471+# the filter type can also be specified explicitly, as shown:
1472+filters:
1473+- pandoc-citeproc
1474+- wordcount.lua
1475+- type: json
1476+ path: foo.lua
1477+
1478+file-scope: false
1479+
1480+data-dir:
1481+
1482+# ERROR, WARNING, or INFO
1483+verbosity: INFO
1484+log-file: log.json
1485+
1486+# citeproc, natbib, or biblatex
1487+cite-method: citeproc
1488+# part, chapter, section, or default:
1489+top-level-division: chapter
1490+abbreviations:
1491+
1492+pdf-engine: pdflatex
1493+pdf-engine-opts:
1494+- "-shell-escape"
1495+# you may also use pdf-engine-opt: with a single option
1496+# pdf-engine-opt: "-shell-escape"
1497+
1498+# auto, preserve, or none
1499+wrap: auto
1500+columns: 78
1501+dpi: 72
1502+
1503+extract-media: mediadir
1504+
1505+table-of-contents: true
1506+toc-depth: 2
14561507number-sections: false
1508+# a list of offsets at each heading level
14571509number-offset: [0,0,0,0,0,0]
1510+# toc: may also be used instead of table-of-contents:
1511+shift-heading-level-by: 1
14581512section-divs: true
1459−incremental: false
1460−self-contained: false
1461−html-q-tags: false
1513+identifier-prefix: foo
1514+title-prefix: ""
1515+strip-empty-paragraphs: true
1516+# lf, crlf, or native
1517+eol: lf
1518+strip-comments: false
1519+indented-code-classes: []
1520+ascii: true
1521+default-image-extension: ".jpg"
1522+
1523+# either a style name of a style definition file:
14621524highlight-style: pygments
14631525syntax-definitions:
14641526- c.xml
1465−# may also use syntax-definition: with a single value
1466−top-level-division: chapter
1527+# or you may use syntax-definition: with a single value
1528+listings: false
1529+
1530+reference-doc: myref.docx
1531+
1532+# method is plain, webtex, gladtex, mathml, mathjax, katex
1533+# you may specify a url with webtex, mathjax, katex
14671534html-math-method:
14681535 method: mathjax
14691536 url: "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"
1470−abbreviations: []
1471−reference-doc: myref.docx
1537+# none, references, or javascript
1538+email-obfuscation: javascript
1539+
1540+tab-stop: 8
1541+preserve-tabs: true
1542+
1543+incremental: false
1544+slide-level: 2
1545+
14721546epub-subdirectory: EPUB
14731547epub-metadata: meta.xml
14741548epub-fonts:
14751549- foobar.otf
14761550epub-chapter-level: 1
14771551epub-cover-image: cover.jpg
1478−toc-depth: 2
1479−dump-args: false
1480−ignore-args: false
1481−verbosity: INFO
1482−trace: false
1483−log-file: log.json
1484−fail-if-warnings: false
1552+
14851553reference-links: true
1486−reference-location: paragraph
1487−dpi: 72
1488−wrap: auto
1489−columns:78
1490−filters:
1491−- pandoc-citeproc
1492−- wordcount.lua
1493−- type: json
1494− path: foo.lua
1495−email-obfuscation: javascript
1496−identifier-prefix: foo
1497−strip-empty-paragraphs: true
1498−indented-code-classes: []
1499−data-dir: null
1500−cite-method: citeproc
1501−listings: false
1502−pdf-engine: pdflatex
1503−pdf-engine-opts: []
1504−# can also use this with a single option:
1505−pdf-engine-opt:
1506−slide-level: 2
1554+# block, section, or document
1555+reference-location: block
15071556setext-headers: true
1508−ascii: true
1509−default-image-extension: ".jpg"
1510−extract-media: mediadir
1511−track-changes: false
1512−file-scope: false
1513−title-prefix: ""
1557+
1558+# accept, reject, or all
1559+track-changes: accept
1560+
1561+html-q-tags: false
15141562css:
15151563- site.css
1564+
1565+# none, all, or best
15161566ipynb-output: best
1517−# Note that these take files, not their contents:
1518−include-before-body: []
1519−include-after-body: []
1520−include-in-header: []
1521−resource-path: ["."]
1567+
1568+# A list of two-element lists
15221569request-headers:
15231570- ["User-Agent", "Mozilla/5.0"]
1524−eol: lf
1525−strip-comments: false
1571+
1572+fail-if-warnings: false
1573+dump-args: false
1574+ignore-args: false
1575+trace: false
15261576```
15271577
15281578# Templates