Improve sample --defaults file in MANUAL.txt.

This commit is contained in:
John MacFarlane 2019-10-11 08:57:49 -07:00
parent 8a64bd0abf
commit 34e6464e30

View file

@ -1427,102 +1427,152 @@ of options. Here is a sample defaults file demonstrating all of
the fields that may be used: the fields that may be used:
``` yaml ``` yaml
tab-stop: 8
preserve-tabs: yes
standalone: true
table-of-contents: true
# toc is a synonym for table-of-contents
from: markdown+emoji from: markdown+emoji
# reader is a synonym for from # reader: may be used instead of from:
to: html5 to: html5
# writer is a synonym for to # writer: may be used instead of to:
shift-heading-level-by: 1
template: leter # leave blank for output to stdout:
output-file:
# leave blank for input from stdin:
input-files:
- preface.md
- content.md
template: letter
standalone: true
self-contained: false
# note that structured variables may be specified:
variables: variables:
documentclass: book documentclass: book
classoptions: classoptions:
- twosides - twosides
- draft - draft
# metadata values specified here are parsed as literal
# string text, not markdown:
metadata: metadata:
author: author:
- Sam Smith - Sam Smith
- Julie Liu - Julie Liu
metadata-files: [] metadata-files:
# you may also use metadata-file with a single value - boilerplate.yaml
output-file: - # or you may use metadata-file: with a single value
input-files:
- preface.md # Note that these take files, not their contents:
- content.md include-before-body: []
include-after-body: []
include-in-header: []
resource-path: ["."]
# filters will be assumed to be lua filters if they have
# the .lua extension, and json filters otherwise. But
# the filter type can also be specified explicitly, as shown:
filters:
- pandoc-citeproc
- wordcount.lua
- type: json
path: foo.lua
file-scope: false
data-dir:
# ERROR, WARNING, or INFO
verbosity: INFO
log-file: log.json
# citeproc, natbib, or biblatex
cite-method: citeproc
# part, chapter, section, or default:
top-level-division: chapter
abbreviations:
pdf-engine: pdflatex
pdf-engine-opts:
- "-shell-escape"
# you may also use pdf-engine-opt: with a single option
# pdf-engine-opt: "-shell-escape"
# auto, preserve, or none
wrap: auto
columns: 78
dpi: 72
extract-media: mediadir
table-of-contents: true
toc-depth: 2
number-sections: false number-sections: false
# a list of offsets at each heading level
number-offset: [0,0,0,0,0,0] number-offset: [0,0,0,0,0,0]
# toc: may also be used instead of table-of-contents:
shift-heading-level-by: 1
section-divs: true section-divs: true
incremental: false identifier-prefix: foo
self-contained: false title-prefix: ""
html-q-tags: false strip-empty-paragraphs: true
# lf, crlf, or native
eol: lf
strip-comments: false
indented-code-classes: []
ascii: true
default-image-extension: ".jpg"
# either a style name of a style definition file:
highlight-style: pygments highlight-style: pygments
syntax-definitions: syntax-definitions:
- c.xml - c.xml
# may also use syntax-definition: with a single value # or you may use syntax-definition: with a single value
top-level-division: chapter listings: false
reference-doc: myref.docx
# method is plain, webtex, gladtex, mathml, mathjax, katex
# you may specify a url with webtex, mathjax, katex
html-math-method: html-math-method:
method: mathjax method: mathjax
url: "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js" url: "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"
abbreviations: [] # none, references, or javascript
reference-doc: myref.docx email-obfuscation: javascript
tab-stop: 8
preserve-tabs: true
incremental: false
slide-level: 2
epub-subdirectory: EPUB epub-subdirectory: EPUB
epub-metadata: meta.xml epub-metadata: meta.xml
epub-fonts: epub-fonts:
- foobar.otf - foobar.otf
epub-chapter-level: 1 epub-chapter-level: 1
epub-cover-image: cover.jpg epub-cover-image: cover.jpg
toc-depth: 2
dump-args: false
ignore-args: false
verbosity: INFO
trace: false
log-file: log.json
fail-if-warnings: false
reference-links: true reference-links: true
reference-location: paragraph # block, section, or document
dpi: 72 reference-location: block
wrap: auto
columns:78
filters:
- pandoc-citeproc
- wordcount.lua
- type: json
path: foo.lua
email-obfuscation: javascript
identifier-prefix: foo
strip-empty-paragraphs: true
indented-code-classes: []
data-dir: null
cite-method: citeproc
listings: false
pdf-engine: pdflatex
pdf-engine-opts: []
# can also use this with a single option:
pdf-engine-opt:
slide-level: 2
setext-headers: true setext-headers: true
ascii: true
default-image-extension: ".jpg" # accept, reject, or all
extract-media: mediadir track-changes: accept
track-changes: false
file-scope: false html-q-tags: false
title-prefix: ""
css: css:
- site.css - site.css
# none, all, or best
ipynb-output: best ipynb-output: best
# Note that these take files, not their contents:
include-before-body: [] # A list of two-element lists
include-after-body: []
include-in-header: []
resource-path: ["."]
request-headers: request-headers:
- ["User-Agent", "Mozilla/5.0"] - ["User-Agent", "Mozilla/5.0"]
eol: lf
strip-comments: false fail-if-warnings: false
dump-args: false
ignore-args: false
trace: false
``` ```
# Templates # Templates