defaults.yaml

# TOP-LEVEL SETTINGS (formats, output-dir, overwrite, include, preprocess-*)

# Source format. Normally 'markdown' but may be overridden if desired
# (most commonly to turn certain Markdown extensions off/on, or so as
# to use the more standardized commonmark/commonmark_x, which is
# more lightweight albeit less featureful).
source-format: 'markdown'

# Which output formats to turn on; valid are all output formats supported by
# pandoc, as well as 'pdf' (meaning by default latex with pdf conversion -- this
# may be configured using the pdf-engine setting). Overridable
# using the --formats (or --to, or -t) command line switch.
#
formats: ['html', 'pdf', 'docx']

# Directory in which to place output files; can be overridden using the
# --output-dir (or -d) switch. If the value is 'auto' (the default), creates a
# dir named $filename.pdc/ in the same directory as the (first) input file. If
# false or empty string, puts output files $filename.$ext in same dir as
# $filename.
output-dir: 'auto'

# If outputdir is a false value, files are only overwritten when this is true.
# (It has no effect when outputdir has a value or is 'auto').
overwrite: false

# Include an external file. Never used in the default config,
# but kept here for the sake of completeness (as well as documentation).
include: ''

# Preprocessing support. It can be overridden by placing these directives
# in specific 'format-*' sections.
# Both directives are strings and may contain spaces.
# Examples of preprocess-command:
#   'm4', 'gpp -H -Imacros.gpp', 'm4 -P ~/.config/pdc/macros.m4 -'
# Example of preprocess-args: '-DPDF -DSLIDES -DBEAMER'
preprocess-command: ''
preprocess-args: ''

# GENERAL OPTIONS, applicable to the reader or to multiple writers.
# Overridable and extensible in the document meta block or in included yaml files,
# at this level or inside 'format-*' sections. Note that 'pdf' format
# uses format-latex settings.
#
# data-dir: ''
# defaults: ''
# verbose: false
# quiet: false
# fail-if-warnings: false
# log: ''

# READER options:
shift-heading-level-by: 0
# base-header-level: 1  ## DEPRECATED: use shift-heading-level-by instead
# strip-empty-paragraphs: false  ## DEPRECATED: use +empty_paragraphs extension
parse-raw: false
indented-code-classes: ''
default-image-extension: ''
file-scope: true
# Output filters/lua-filters; note that these are lists resulting
# in potentially repeated '--filter=X'/--lua-filter=X' parameters.
filters: []
lua-filters: []
# Metadata dict. This overrides document metadata but is
# in turn overridden by format-* metadata.
# metadata: {}
# metadata-file: ''
preserve-tabs: false
tab-stop: 4
abbreviations: ''
trace: false
# Omitted as not relevant for markdown input: track-changes, extract-media

# WRITER options:
standalone: true
# Template-basename is only used if template is not specified
# and ~/.pandoc/templates/${template_basename}.${format} is found.
# (Obviously, 'template' only makes sense for a specific output format.)
template-basename: ''
# Potentially repeated -V parameters
# variables: {}
# [Omitted: -D (--print-default-template), --print-default-data-file]
# eol: 'native'
# dpi: 96
wrap: auto
columns: 78
toc: false
toc-depth: 3
strip-comments: false
no-highlight: false
# highlight-style: pygments
# [Omitted: print-highlight-style, syntax-definition]
include-in-header: []
include-before-body: []
include-after-body: []
resource-path: ''
# [Omitted: request-header, no-check-certificate]
# For html, latex, docbook, epub
# OBSOLETE: chapters: false [now: top-level-division: chapter]
top-level-division: default
number-sections: false
# for markdown, rst, asciidoc output
atx-headers: false
reference-links: false
# reference-location: document
# for slide formats
incremental: false
# slide-level: 0
# Citations - see also under format-latex and format-beamer.
citeproc: false
csl: ''
bibliography: ''
citation-abbreviations: ''
# caption position
table-caption-position: above
figure-caption-position: below

#
# FORMAT-* SECTIONS
#

# Default options intended for html as well as revealjs and other
# html-based slides formats. Note that format-html4, etc. do not inherit from
# this automatically but have to explicitly point to it using the 'inherit'
# key.
format-html:
    # 'extension' is overridden in format-html and format-epub,
    # which inherit these settings
    extension: 'html'
    # This is now (v2.19+) deprecated, replaced by --embed-resources --standalone
    #self-contained: true
    standalone: true
    embed-resources: true
    html-q-tags: false
    ascii: false
    number-offset: ''
    section-divs: false
    email-obfuscation: 'none'
    id-prefix: ''
    title-prefix: ''
    css: []
    # math representation
    mathml: false
    mathjax: false
    gladtex: false
    webtex: false
    katex: false
    katex-stylesheet: ''

format-html5:
    # There is no longer any difference between html and html5
    inherit: 'html'

format-html4:
    inherit: 'html'
    extension: 'htm'

format-epub3:
    ENV:
        SOURCE_DATE_EPOCH: source-file
    inherit: 'html5'
    epub-stylesheet: ''
    epub-cover-image: ''
    epub-metadata: ''
    epub-embed-font: ''
    epub-chapter-level: 1
    epub-subdirectory: 'EPUB'

format-epub:
    inherit: 'epub3'

format-ipynb:
    inherit: 'html5'
    ipynb-output-all: 'best'

format-odt:
    ENV:
        SOURCE_DATE_EPOCH: source-file
    reference-doc: ''
    # Obsolete: reference-odt
    generate-pdf: false
    pdf-extension: 'odt.pdf'

format-docx:
    ENV:
        SOURCE_DATE_EPOCH: source-file
    reference-doc: ''
    # Obsolete: reference-docx
    generate-pdf: false
    pdf-extension: 'docx.pdf'

format-latex:
    # Note that 'format-latex' applies to normal PDF generation
    # (with 'pdf' in 'formats').
    #
    # If 'generate-pdf' is true, generate pdf in a separate step.
    # (The normal way of generating pdf is to set this as false but
    # to specify 'pdf' in 'formats'. This setting is intended for beamer
    # and for postprocessed latex).
    generate-pdf: false
    extension: 'tex'
    pdf-extension: 'pdf'
    no-tex-ligatures: false
    listings: false
    # If either biblatex or natbib is true, pdf (if specified in 'formats')
    # is produced in a separate step using latexmk, which needs to be in $PATH.
    biblatex: false
    natbib: false
    # Referenced images will by default be copied to the pdc-extracted-media
    # subdirectory of the *.pdc output directory.
    extract-media: true
    # Note that standard pandoc variables for LaTeX in the document metablock
    # (also outside the pdc section) will override these options. Only define
    # the keys you need to be *default* here.
    # Documentation: https://pandoc.org/MANUAL.html#variables - and more
    # specifically - https://pandoc.org/MANUAL.html#variables-for-latex
    variables:
        papersize: a4
        fontsize: 12pt
        documentclass: article
        geometry: 'margin=3cm'
        linestretch: 1.15
        biblio-style: 'authoryear'

format-context:
    # We prefer .mkiv to .tex so as not to conflict with LaTeX
    extension: 'mkiv'
    generate-pdf: false
    pdf-extension: 'mkiv.pdf'
    extract-media: true
    # See https://pandoc.org/MANUAL.html#variables-for-context
    variables:
        papersize: A4
        fontsize: 12pt
        indenting: false
        interlinespace: 3ex
        margin-left: 3cm
        margin-right: 3cm
        margin-top: 3cm
        margin-bottom: 3cm

format-typst:
    extension: 'typ'
    generate-pdf: false
    variables:
        # NOTE: no support for dict values for variables on command line, so
        # margin must be set directly in the top-level meta or in a separate file.
        papersize: a4
        fontsize: 12pt

format-pdf:
    # NOTE: For format-pdf, indicate inheritance with `pdf-engine`
    #       rather than `inherit`.
    #
    # - Valid LaTeX values (implying -t latex):
    #     pdflatex, lualatex, xelatex, latexmk, tectonic.
    # - Other valid TeX values (implying -t context):
    #     context.
    # - Valid HTML-based values (implying -t html):
    #     wkhtmltopdf, weasyprint, pagedjs-cli, prince
    # - Other:
    #     pdfroff (implying -t ms), typst (implying -t typst)
    #
    # To generate PDF via other formats (e.g. docx, odt), use
    # the `generate-pdf` option there rather the `formats` list
    #
    pdf-engine: 'lualatex'
    pdf-engine-opt: []

format-beamer:
    generate-pdf: true
    extension: 'beamer.tex'
    pdf-extension: 'beamer.pdf'
    no-tex-ligatures: false
    listings: false
    pdf-engine: 'xelatex'
    pdf-engine-opt: []
    biblatex: false
    natbib: false

format-ms:
    generate-pdf: false
    # pdf-extension: 'ms.pdf'
    # variables:
    #    fontfamily: P
    #    indent: 2m
    #    lineheight: 12p
    #    pointsize: 10p

format-rtf:
    generate-pdf: false
    pdf-extension: 'rtf.pdf'

### UNCONFIGURED FORMATS
###
### The following output formats do not currently have their own format-*
### section:
###
### asciidoc asciidoc_legacy asciidoctor biblatex bibtex commonmark commonmark_x
### csljson djot docbook docbook4 docbook5 dokuwiki dzslides epub2 fb2 gfm
### haddock icml jats jats_archiving jats_articleauthoring jats_publishing jira
### json man markdown markdown_github markdown_mmd markdown_phpextra
### markdown_strict markua mediawiki muse native opendocument opml org plain
### pptx revealjs rst s5 slideous slidy tei texinfo textile xwiki zimwiki