aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README699
1 files changed, 521 insertions, 178 deletions
diff --git a/README b/README
index d2fcd51f1..38b8a588e 100644
--- a/README
+++ b/README
@@ -1,27 +1,29 @@
% Pandoc User's Guide
% John MacFarlane
-% August 30, 2014
+% July 15, 2015
Synopsis
========
-pandoc [*options*] [*input-file*]...
+`pandoc` [*options*] [*input-file*]...
Description
===========
Pandoc is a [Haskell] library for converting from one markup format to
another, and a command-line tool that uses this library. It can read
-[markdown] and (subsets of) [Textile], [reStructuredText], [HTML],
-[LaTeX], [MediaWiki markup], [Haddock markup], [OPML], [Emacs
-Org-mode], [DocBook], [txt2tags], [EPUB] and [Word docx]; and it can write plain text,
-[markdown], [reStructuredText], [XHTML], [HTML 5], [LaTeX] (including
+[Markdown], [CommonMark], and (subsets of) [Textile],
+[reStructuredText], [HTML], [LaTeX], [MediaWiki markup], [TWiki
+markup], [Haddock markup], [OPML], [Emacs Org-mode], [DocBook],
+[txt2tags], [EPUB], [ODT] and [Word docx]; and it can write plain text,
+[Markdown], [reStructuredText], [XHTML], [HTML 5], [LaTeX] (including
[beamer] slide shows), [ConTeXt], [RTF], [OPML], [DocBook],
[OpenDocument], [ODT], [Word docx], [GNU Texinfo], [MediaWiki markup],
-[DokuWiki markup], [Haddock markup], [EPUB] (v2 or v3), [FictionBook2],
-[Textile], [groff man] pages, [Emacs Org-Mode], [AsciiDoc], [InDesign ICML],
-and [Slidy], [Slideous], [DZSlides], [reveal.js] or [S5] HTML slide shows.
-It can also produce [PDF] output on systems where LaTeX is installed.
+[DokuWiki markup], [Haddock markup], [EPUB] (v2 or v3),
+[FictionBook2], [Textile], [groff man] pages, [Emacs Org-Mode],
+[AsciiDoc], [InDesign ICML], and [Slidy], [Slideous], [DZSlides],
+[reveal.js] or [S5] HTML slide shows. It can also produce [PDF] output
+on systems where LaTeX is installed.
Pandoc's enhanced version of markdown includes syntax for footnotes,
tables, flexible ordered lists, definition lists, fenced code blocks,
@@ -50,6 +52,15 @@ default (though output to *stdout* is disabled for the `odt`, `docx`,
pandoc -o output.html input.txt
+By default, pandoc produces a document fragment, not a standalone
+document with a proper header and footer. To produce a standalone
+document, use the `-s` or `--standalone` flag:
+
+ pandoc -s -o output.html input.txt
+
+For more information on how standalone documents are produced, see
+[Templates](#templates), below.
+
Instead of a file, an absolute URI may be given. In this case
pandoc will fetch the content using HTTP:
@@ -57,7 +68,7 @@ pandoc will fetch the content using HTTP:
If multiple input files are given, `pandoc` will concatenate them all (with
blank lines between them) before parsing. This feature is disabled for
- binary input formats such as `EPUB` and `docx`.
+ binary input formats such as `EPUB`, `odt`, and `docx`.
The format of the input and output can be specified explicitly using
command-line options. The input format can be specified using the
@@ -95,6 +106,11 @@ should pipe input and output through `iconv`:
iconv -t utf-8 input.txt | pandoc | iconv -f utf-8
+Note that in some output formats (such as HTML, LaTeX, ConTeXt,
+RTF, OPML, DocBook, and Texinfo), information about
+the character encoding is included in the document header, which
+will only be included if you use the `-s/--standalone` option.
+
Creating a PDF
--------------
@@ -111,7 +127,8 @@ Production of a PDF requires that a LaTeX engine be installed (see
`--latex-engine`, below), and assumes that the following LaTeX packages are
available: `amssymb`, `amsmath`, `ifxetex`, `ifluatex`, `listings` (if the
`--listings` option is used), `fancyvrb`, `longtable`, `booktabs`, `url`,
-`graphicx`, `hyperref`, `ulem`, `babel` (if the `lang` variable is set),
+`graphicx` and `grffile` (if the document contains images),
+ `hyperref`, `ulem`, `babel` (if the `lang` variable is set),
`fontspec` (if `xelatex` or `lualatex` is used as the LaTeX engine), `xltxtra`
and `xunicode` (if `xelatex` is used).
@@ -139,62 +156,70 @@ General options
---------------
`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*
+
: Specify input format. *FORMAT* can be `native` (native Haskell),
`json` (JSON version of native AST), `markdown` (pandoc's
- extended markdown), `markdown_strict` (original unextended markdown),
- `markdown_phpextra` (PHP Markdown Extra extended markdown),
- `markdown_github` (github extended markdown),
- `textile` (Textile), `rst` (reStructuredText), `html` (HTML),
- `docbook` (DocBook), `t2t` (txt2tags), `docx` (docx), `epub` (EPUB),
- `opml` (OPML), `org` (Emacs Org-mode), `mediawiki` (MediaWiki markup),
- `haddock` (Haddock markup), or `latex` (LaTeX). If `+lhs` is appended
- to `markdown`, `rst`,
- `latex`, or `html`, the input will be treated as literate Haskell
- source: see [Literate Haskell support](#literate-haskell-support),
- below. Markdown syntax extensions can be individually enabled or
- disabled by appending `+EXTENSION` or `-EXTENSION` to the format
- name. So, for example, `markdown_strict+footnotes+definition_lists`
- is strict markdown with footnotes and definition lists enabled,
- and `markdown-pipe_tables+hard_line_breaks` is pandoc's markdown
+ extended markdown), `markdown_strict` (original unextended
+ markdown), `markdown_phpextra` (PHP Markdown Extra extended
+ markdown), `markdown_github` (github extended markdown),
+ `commonmark` (CommonMark markdown), `textile` (Textile), `rst`
+ (reStructuredText), `html` (HTML), `docbook` (DocBook), `t2t`
+ (txt2tags), `docx` (docx), `odt` (ODT), `epub` (EPUB), `opml` (OPML),
+ `org` (Emacs Org-mode), `mediawiki` (MediaWiki markup), `twiki` (TWiki
+ markup), `haddock` (Haddock markup), or `latex` (LaTeX). If
+ `+lhs` is appended to `markdown`, `rst`, `latex`, or `html`, the
+ input will be treated as literate Haskell source: see [Literate
+ Haskell support](#literate-haskell-support), below. Markdown
+ syntax extensions can be individually enabled or disabled by
+ appending `+EXTENSION` or `-EXTENSION` to the format name. So, for
+ example, `markdown_strict+footnotes+definition_lists` is strict
+ markdown with footnotes and definition lists enabled, and
+ `markdown-pipe_tables+hard_line_breaks` is pandoc's markdown
without pipe tables and with hard line breaks. See [Pandoc's
markdown](#pandocs-markdown), below, for a list of extensions and
their names.
`-t` *FORMAT*, `-w` *FORMAT*, `--to=`*FORMAT*, `--write=`*FORMAT*
+
: Specify output format. *FORMAT* can be `native` (native Haskell),
`json` (JSON version of native AST), `plain` (plain text),
- `markdown` (pandoc's extended markdown), `markdown_strict` (original
- unextended markdown), `markdown_phpextra` (PHP Markdown extra
- extended markdown), `markdown_github` (github extended markdown),
- `rst` (reStructuredText), `html` (XHTML 1), `html5` (HTML 5),
- `latex` (LaTeX), `beamer` (LaTeX beamer slide show),
- `context` (ConTeXt), `man` (groff man), `mediawiki` (MediaWiki markup),
- `dokuwiki` (DokuWiki markup),
- `textile` (Textile), `org` (Emacs Org-Mode), `texinfo` (GNU Texinfo),
- `opml` (OPML), `docbook` (DocBook), `opendocument` (OpenDocument), `odt`
- (OpenOffice text document), `docx` (Word docx), `haddock` (Haddock
- markup), `rtf` (rich text format), `epub` (EPUB v2 book), `epub3`
- (EPUB v3), `fb2` (FictionBook2 e-book), `asciidoc` (AsciiDoc),
- `icml` (InDesign ICML), `slidy` (Slidy HTML and javascript slide show),
- `slideous` (Slideous HTML and javascript slide show), `dzslides`
- (DZSlides HTML5 + javascript slide show), `revealjs` (reveal.js
- HTML5 + javascript slide show), `s5` (S5 HTML and javascript slide show),
- or the path of a custom lua writer (see [Custom writers](#custom-writers),
- below). Note that `odt`, `epub`, and `epub3` output will not be directed
- to *stdout*; an output filename must be specified using the `-o/--output`
- option. If `+lhs` is appended to `markdown`, `rst`, `latex`, `beamer`,
- `html`, or `html5`, the output will be rendered as literate Haskell
- source: see [Literate Haskell support](#literate-haskell-support), below.
- Markdown syntax extensions can be individually enabled or disabled by
- appending `+EXTENSION` or `-EXTENSION` to the format name, as described
+ `markdown` (pandoc's extended markdown), `markdown_strict`
+ (original unextended markdown), `markdown_phpextra` (PHP Markdown
+ extra extended markdown), `markdown_github` (github extended
+ markdown), `commonmark` (CommonMark markdown), `rst`
+ (reStructuredText), `html` (XHTML 1), `html5` (HTML 5), `latex`
+ (LaTeX), `beamer` (LaTeX beamer slide show), `context` (ConTeXt),
+ `man` (groff man), `mediawiki` (MediaWiki markup), `dokuwiki`
+ (DokuWiki markup), `textile` (Textile), `org` (Emacs Org-Mode),
+ `texinfo` (GNU Texinfo), `opml` (OPML), `docbook` (DocBook),
+ `opendocument` (OpenDocument), `odt` (OpenOffice text document),
+ `docx` (Word docx), `haddock` (Haddock markup), `rtf` (rich text
+ format), `epub` (EPUB v2 book), `epub3` (EPUB v3), `fb2`
+ (FictionBook2 e-book), `asciidoc` (AsciiDoc), `icml` (InDesign
+ ICML), `slidy` (Slidy HTML and javascript slide show), `slideous`
+ (Slideous HTML and javascript slide show), `dzslides` (DZSlides
+ HTML5 + javascript slide show), `revealjs` (reveal.js HTML5 +
+ javascript slide show), `s5` (S5 HTML and javascript slide show),
+ or the path of a custom lua writer (see [Custom
+ writers](#custom-writers), below). Note that `odt`, `epub`, and
+ `epub3` output will not be directed to *stdout*; an output
+ filename must be specified using the `-o/--output` option. If
+ `+lhs` is appended to `markdown`, `rst`, `latex`, `beamer`,
+ `html`, or `html5`, the output will be rendered as literate
+ Haskell source: see [Literate Haskell
+ support](#literate-haskell-support), below. Markdown syntax
+ extensions can be individually enabled or disabled by appending
+ `+EXTENSION` or `-EXTENSION` to the format name, as described
above under `-f`.
`-o` *FILE*, `--output=`*FILE*
+
: Write output to *FILE* instead of *stdout*. If *FILE* is
`-`, output will go to *stdout*. (Exception: if the output
format is `odt`, `docx`, `epub`, or `epub3`, output to stdout is disabled.)
`--data-dir=`*DIRECTORY*
+
: Specify the user data directory to search for pandoc data files.
If this option is not specified, the default user data directory
will be used. This is
@@ -215,16 +240,24 @@ General options
`epub.css`, `templates`, `slidy`, `slideous`, or `s5` directory
placed in this directory will override pandoc's normal defaults.
+`--verbose`
+
+: Give verbose debugging output. Currently this only has an effect
+ with PDF output.
+
`-v`, `--version`
+
: Print version.
`-h`, `--help`
+
: Show usage message.
Reader options
--------------
`-R`, `--parse-raw`
+
: Parse untranslatable HTML codes and LaTeX environments as raw HTML
or LaTeX, instead of ignoring them. Affects only HTML and LaTeX
input. Raw HTML can be printed in markdown, reStructuredText, HTML,
@@ -235,35 +268,41 @@ Reader options
LaTeX *commands*, even if `-R` is not specified.)
`-S`, `--smart`
+
: Produce typographically correct output, converting straight quotes
to curly quotes, `---` to em-dashes, `--` to en-dashes, and
`...` to ellipses. Nonbreaking spaces are inserted after certain
abbreviations, such as "Mr." (Note: This option is significant only when
- the input format is `markdown`, `markdown_strict`, or `textile`. It
- is selected automatically when the input format is `textile` or the
+ the input format is `markdown`, `markdown_strict`, `textile` or `twiki`.
+ It is selected automatically when the input format is `textile` or the
output format is `latex` or `context`, unless `--no-tex-ligatures`
is used.)
`--old-dashes`
+
: Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes: `-` before
a numeral is an en-dash, and `--` is an em-dash. This option is selected
automatically for `textile` input.
`--base-header-level=`*NUMBER*
+
: Specify the base level for headers (defaults to 1).
`--indented-code-classes=`*CLASSES*
+
: Specify classes to use for indented code blocks--for example,
`perl,numberLines` or `haskell`. Multiple classes may be separated
by spaces or commas.
`--default-image-extension=`*EXTENSION*
+
: Specify a default extension to use when image paths/URLs have no
extension. This allows you to use the same source for formats that
require different kinds of images. Currently this option only affects
the markdown and LaTeX readers.
`--filter=`*EXECUTABLE*
+
: Specify an executable to be used as a filter transforming the
Pandoc AST after the input is parsed and before the output is
written. The executable should read JSON from stdin and write
@@ -284,12 +323,18 @@ Reader options
Those who would prefer to write filters in python can use the
module `pandocfilters`, installable from PyPI. See
<http://github.com/jgm/pandocfilters> for the module and several
- examples. Note that the *EXECUTABLE* will be sought in the user's
+ examples. There are also pandoc filter libraries in
+ [PHP](https://github.com/vinai/pandocfilters-php),
+ [perl](https://metacpan.org/pod/Pandoc::Filter), and
+ [javascript/node.js](https://github.com/mvhenderson/pandoc-filter-node).
+
+ Note that the *EXECUTABLE* will be sought in the user's
`PATH`, and not in the working directory, if no directory is
provided. If you want to run a script in the working directory,
preface the filename with `./`.
-`-M` *KEY[=VAL]*, `--metadata=`*KEY[:VAL]*
+`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
+
: Set the metadata field *KEY* to the value *VAL*. A value specified
on the command line overrides a value specified in the document.
Values will be parsed as YAML boolean or string values. If no value is
@@ -300,29 +345,34 @@ Reader options
printed in some output formats).
`--normalize`
+
: Normalize the document after reading: merge adjacent
`Str` or `Emph` elements, for example, and remove repeated `Space`s.
`-p`, `--preserve-tabs`
+
: Preserve tabs instead of converting them to spaces (the default).
Note that this will only affect tabs in literal code spans and code
blocks; tabs in regular text will be treated as spaces.
`--tab-stop=`*NUMBER*
+
: Specify the number of spaces per tab (default is 4).
-`--track-changes=`*accept|reject|all*
+`--track-changes=accept`|`reject`|`all`
+
: Specifies what to do with insertions and deletions produced by the MS
- Word "track-changes" feature. *accept* (the default), inserts all
- insertions, and ignores all deletions. *reject* inserts all
- deletions and ignores insertions. *all* puts in both insertions
+ Word "track-changes" feature. `accept` (the default), inserts all
+ insertions, and ignores all deletions. `reject` inserts all
+ deletions and ignores insertions. `all` puts in both insertions
and deletions, wrapped in spans with `insertion` and `deletion`
classes, respectively. The author and time of change is
- included. *all* is useful for scripting: only accepting changes
+ included. `all` is useful for scripting: only accepting changes
from a certain reviewer, say, or before a certain date. This
option only affects the docx reader.
`--extract-media=`*DIR*
+
: Extract images and other media contained in a docx or epub container
to the path *DIR*, creating it if necessary, and adjust the images
references in the document so they point to the extracted files.
@@ -332,23 +382,26 @@ General writer options
----------------------
`-s`, `--standalone`
+
: Produce output with an appropriate header and footer (e.g. a
standalone HTML, LaTeX, or RTF file, not a fragment). This option
is set automatically for `pdf`, `epub`, `epub3`, `fb2`, `docx`, and `odt`
output.
`--template=`*FILE*
+
: Use *FILE* as a custom template for the generated document. Implies
`--standalone`. See [Templates](#templates) below for a description
of template syntax. If no extension is specified, an extension
corresponding to the writer will be added, so that `--template=special`
looks for `special.html` for HTML output. If the template is not
- found, pandoc will search for it in the user data directory
- (see `--data-dir`). If this option is not used, a default
- template appropriate for the output format will be used (see
+ found, pandoc will search for it in the `templates` subdirectory of
+ the user data directory (see `--data-dir`). If this option is not used,
+ a default template appropriate for the output format will be used (see
`-D/--print-default-template`).
-`-V` *KEY[=VAL]*, `--variable=`*KEY[:VAL]*
+`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
+
: Set the template variable *KEY* to the value *VAL* when rendering the
document in standalone mode. This is generally only useful when the
`--template` option is used to specify a custom template, since
@@ -357,40 +410,52 @@ General writer options
value `true`.
`-D` *FORMAT*, `--print-default-template=`*FORMAT*
-: Print the default template for an output *FORMAT*. (See `-t`
- for a list of possible *FORMAT*s.)
+
+: Print the system default template for an output *FORMAT*. (See `-t`
+ for a list of possible *FORMAT*s.) Templates in the user data
+ directory are ignored.
`--print-default-data-file=`*FILE*
-: Print a default data file.
+
+: Print a system default data file. Files in the user data directory
+ are ignored.
`--no-wrap`
+
: Disable text wrapping in output. By default, text is wrapped
appropriately for the output format.
-`--columns`=*NUMBER*
+`--columns=`*NUMBER*
+
: Specify length of lines in characters (for text wrapping).
`--toc`, `--table-of-contents`
+
: Include an automatically generated table of contents (or, in
the case of `latex`, `context`, and `rst`, an instruction to create
one) in the output document. This option has no effect on `man`,
`docbook`, `slidy`, `slideous`, `s5`, `docx`, or `odt` output.
`--toc-depth=`*NUMBER*
+
: Specify the number of section levels to include in the table
of contents. The default is 3 (which means that level 1, 2, and 3
headers will be listed in the contents).
`--no-highlight`
+
: Disables syntax highlighting for code blocks and inlines, even when
a language attribute is given.
-`--highlight-style`=*STYLE*
+`--highlight-style=`*STYLE*
+
: Specifies the coloring style to be used in highlighted source code.
Options are `pygments` (the default), `kate`, `monochrome`,
- `espresso`, `zenburn`, `haddock`, and `tango`.
+ `espresso`, `zenburn`, `haddock`, and `tango`. For more information
+ on syntax highlighting in pandoc, see [Syntax highlighting], below.
`-H` *FILE*, `--include-in-header=`*FILE*
+
: Include contents of *FILE*, verbatim, at the end of the header.
This can be used, for example, to include special
CSS or javascript in HTML documents. This option can be used
@@ -398,6 +463,7 @@ General writer options
included in the order specified. Implies `--standalone`.
`-B` *FILE*, `--include-before-body=`*FILE*
+
: Include contents of *FILE*, verbatim, at the beginning of the
document body (e.g. after the `<body>` tag in HTML, or the
`\begin{document}` command in LaTeX). This can be used to include
@@ -406,6 +472,7 @@ General writer options
the order specified. Implies `--standalone`.
`-A` *FILE*, `--include-after-body=`*FILE*
+
: Include contents of *FILE*, verbatim, at the end of the document
body (before the `</body>` tag in HTML, or the
`\end{document}` command in LaTeX). This option can be be used
@@ -416,6 +483,7 @@ Options affecting specific writers
----------------------------------
`--self-contained`
+
: Produce a standalone HTML file with no external dependencies, using
`data:` URIs to incorporate the contents of linked scripts, stylesheets,
images, and videos. The resulting file should be "self-contained,"
@@ -429,41 +497,50 @@ Options affecting specific writers
file is remote). `--self-contained` does not work with `--mathjax`.
`--offline`
+
: Deprecated synonym for `--self-contained`.
`-5`, `--html5`
+
: Produce HTML5 instead of HTML4. This option has no effect for writers
other than `html`. (*Deprecated:* Use the `html5` output format instead.)
`--html-q-tags`
+
: Use `<q>` tags for quotes in HTML.
`--ascii`
+
: Use only ascii characters in output. Currently supported only
for HTML output (which uses numerical entities instead of
UTF-8 when this option is selected).
`--reference-links`
+
: Use reference-style links, rather than inline links, in writing markdown
or reStructuredText. By default inline links are used.
`--atx-headers`
+
: Use ATX style headers in markdown and asciidoc output. The default is
to use setext-style headers for levels 1-2, and then ATX headers.
`--chapters`
+
: Treat top-level headers as chapters in LaTeX, ConTeXt, and DocBook
output. When the LaTeX template uses the report, book, or
memoir class, this option is implied. If `beamer` is the output
format, top-level headers will become `\part{..}`.
`-N`, `--number-sections`
+
: Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.
By default, sections are not numbered. Sections with class
`unnumbered` will never be numbered, even if `--number-sections`
is specified.
-`--number-offset`=*NUMBER[,NUMBER,...]*,
+`--number-offset=`*NUMBER*[`,`*NUMBER*`,`*...*]
+
: Offset for section headings in HTML output (ignored in other
output formats). The first number is added to the section number for
top-level headers, the second for second-level headers, and so on.
@@ -474,6 +551,7 @@ Options affecting specific writers
Offsets are 0 by default. Implies `--number-sections`.
`--no-tex-ligatures`
+
: Do not convert quotation marks, apostrophes, and dashes to
the TeX ligatures when writing LaTeX or ConTeXt. Instead, just
use literal unicode characters. This is needed for using advanced
@@ -485,13 +563,16 @@ Options affecting specific writers
without `--smart`.
`--listings`
+
: Use listings package for LaTeX code blocks
`-i`, `--incremental`
+
: Make list items in slide shows display incrementally (one by one).
The default is for lists to be displayed all at once.
-`--slide-level`=*NUMBER*
+`--slide-level=`*NUMBER*
+
: Specifies that headers with the specified level create
slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headers
above this level in the hierarchy are used to divide the
@@ -501,34 +582,40 @@ Options affecting specific writers
[Structuring the slide show](#structuring-the-slide-show), below.
`--section-divs`
+
: Wrap sections in `<div>` tags (or `<section>` tags in HTML5),
and attach identifiers to the enclosing `<div>` (or `<section>`)
- rather than the header itself.
- See [Section identifiers](#header-identifiers-in-html-latex-and-context), below.
+ rather than the header itself. See
+ [Header identifiers](#header-identifiers), below.
+
+`--email-obfuscation=none`|`javascript`|`references`
-`--email-obfuscation=`*none|javascript|references*
: Specify a method for obfuscating `mailto:` links in HTML documents.
- *none* leaves `mailto:` links as they are. *javascript* obfuscates
- them using javascript. *references* obfuscates them by printing their
+ `none` leaves `mailto:` links as they are. `javascript` obfuscates
+ them using javascript. `references` obfuscates them by printing their
letters as decimal or hexadecimal character references.
-`--id-prefix`=*STRING*
+`--id-prefix=`*STRING*
+
: Specify a prefix to be added to all automatically generated identifiers
in HTML and DocBook output, and to footnote numbers in markdown output.
This is useful for preventing duplicate identifiers when generating
fragments to be included in other pages.
`-T` *STRING*, `--title-prefix=`*STRING*
+
: Specify *STRING* as a prefix at the beginning of the title
that appears in the HTML header (but not in the title as it
appears at the beginning of the HTML body). Implies
`--standalone`.
`-c` *URL*, `--css=`*URL*
+
: Link to a CSS style sheet. This option can be be used repeatedly to
include multiple files. They will be included in the order specified.
`--reference-odt=`*FILE*
+
: Use the specified file as a style reference in producing an ODT.
For best results, the reference ODT should be a modified version
of an ODT produced using pandoc. The contents of the reference ODT
@@ -539,6 +626,7 @@ Options affecting specific writers
used.
`--reference-docx=`*FILE*
+
: Use the specified file as a style reference in producing a docx file.
For best results, the reference docx should be a modified version
of a docx file produced using pandoc. The contents of the reference docx
@@ -548,25 +636,30 @@ Options affecting specific writers
for a file `reference.docx` in the user data directory (see
`--data-dir`). If this is not found either, sensible defaults will be
used. The following styles are used by pandoc: [paragraph]
- Normal, Compact, Title, Subtitle, Authors, Date, Abstract, Heading 1,
- Heading 2, Heading 3, Heading 4, Heading 5, Block Quote, Definition Term,
- Definition, Bibliography, Body Text, Table Caption, Image Caption;
+ Normal, Body Text, First Paragraph, Compact, Title, Subtitle, Author, Date,
+ Abstract, Bibliography, Heading 1, Heading 2, Heading 3, Heading 4,
+ Heading 5, Heading 6, Block Text, Footnote Text, Definition Term,
+ Definition, Caption, Table Caption, Image Caption, Figure,
+ Figure With Caption, TOC Heading;
[character] Default Paragraph Font, Body Text Char, Verbatim Char,
- Footnote Ref, Link.
+ Footnote Reference, Hyperlink; [table] Normal Table.
`--epub-stylesheet=`*FILE*
+
: Use the specified CSS file to style the EPUB. If no stylesheet
is specified, pandoc will look for a file `epub.css` in the
user data directory (see `--data-dir`). If it is not
found there, sensible defaults will be used.
`--epub-cover-image=`*FILE*
+
: Use the specified image as the EPUB cover. It is recommended
that the image be less than 1000px in width and height. Note that
in a markdown source document you can also specify `cover-image`
in a YAML metadata block (see [EPUB Metadata], below).
`--epub-metadata=`*FILE*
+
: Look in the specified XML file for metadata for the EPUB.
The file should contain a series of Dublin Core elements,
as documented at <http://dublincore.org/documents/dces/>.
@@ -588,10 +681,14 @@ Options affecting specific writers
[EPUB Metadata].
`--epub-embed-font=`*FILE*
+
: Embed the specified font in the EPUB. This option can be repeated
- to embed multiple fonts. To use embedded fonts, you
- will need to add declarations like the following to your CSS (see
- `--epub-stylesheet`):
+ to embed multiple fonts. Wildcards can also be used: for example,
+ `DejaVuSans-*.ttf`. However, if you use wildcards on the command
+ line, be sure to escape them or put the whole filename in single quotes,
+ to prevent them from being interpreted by the shell. To use the
+ embedded fonts, you will need to add declarations like the following
+ to your CSS (see `--epub-stylesheet`):
@font-face {
font-family: DejaVuSans;
@@ -620,6 +717,7 @@ Options affecting specific writers
body { font-family: "DejaVuSans"; }
`--epub-chapter-level=`*NUMBER*
+
: Specify the header level at which to split the EPUB into separate
"chapter" files. The default is to split into chapters at level 1
headers. This option only affects the internal composition of the
@@ -628,37 +726,55 @@ Options affecting specific writers
documents with few level 1 headers, one might want to use a chapter
level of 2 or 3.
-`--latex-engine=`*pdflatex|lualatex|xelatex*
+`--latex-engine=pdflatex`|`lualatex`|`xelatex`
+
: Use the specified LaTeX engine when producing PDF output.
The default is `pdflatex`. If the engine is not in your PATH,
the full path of the engine may be specified here.
+`--latex-engine-opt=`*STRING*
+
+: Use the given string as a command-line argument to the `latex-engine`.
+ If used multiple times, the arguments are provided with spaces between
+ them. Note that no check for duplicate options is done.
+
Citation rendering
------------------
`--bibliography=`*FILE*
+
: Set the `bibliography` field in the document's metadata to *FILE*,
overriding any value set in the metadata, and process citations
using `pandoc-citeproc`. (This is equivalent to
`--metadata bibliography=FILE --filter pandoc-citeproc`.)
+ If `--natbib` or `--biblatex` is also supplied, `pandoc-citeproc` is not
+ used, making this equivalent to `--metadata bibliography=FILE`.
+ If you supply this argument multiple times, each *FILE* will be added
+ to bibliography.
`--csl=`*FILE*
+
: Set the `csl` field in the document's metadata to *FILE*,
overriding any value set in the metadata. (This is equivalent to
`--metadata csl=FILE`.)
+ This option is only relevant with `pandoc-citeproc`.
`--citation-abbreviations=`*FILE*
+
: Set the `citation-abbreviations` field in the document's metadata to
*FILE*, overriding any value set in the metadata. (This is equivalent to
`--metadata citation-abbreviations=FILE`.)
+ This option is only relevant with `pandoc-citeproc`.
`--natbib`
+
: Use natbib for citations in LaTeX output. This option is not for use
with the `pandoc-citeproc` filter or with PDF output. It is intended for
use in producing a LaTeX file that can be processed with pdflatex and
bibtex.
`--biblatex`
+
: Use biblatex for citations in LaTeX output. This option is not for use
with the `pandoc-citeproc` filter or with PDF output. It is intended for
use in producing a LaTeX file that can be processed with pdflatex and
@@ -667,7 +783,8 @@ Citation rendering
Math rendering in HTML
----------------------
-`-m` [*URL*], `--latexmathml`[=*URL*]
+`-m` [*URL*], `--latexmathml`[`=`*URL*]
+
: Use the [LaTeXMathML] script to display embedded TeX math in HTML output.
To insert a link to a local copy of the `LaTeXMathML.js` script,
provide a *URL*. If no *URL* is provided, the contents of the
@@ -676,13 +793,15 @@ Math rendering in HTML
several pages, it is much better to link to a copy of the script,
so it can be cached.
-`--mathml`[=*URL*]
+`--mathml`[`=`*URL*]
+
: Convert TeX math to MathML (in `docbook` as well as `html` and `html5`).
In standalone `html` output, a small javascript (or a link to such a
script if a *URL* is supplied) will be inserted that allows the MathML to
be viewed on some browsers.
-`--jsmath`[=*URL*]
+`--jsmath`[`=`*URL*]
+
: Use [jsMath] to display embedded TeX math in HTML output.
The *URL* should point to the jsMath load script (e.g.
`jsMath/easy/load.js`); if provided, it will be linked to in
@@ -690,40 +809,47 @@ Math rendering in HTML
no link to the jsMath load script will be inserted; it is then
up to the author to provide such a link in the HTML template.
-`--mathjax`[=*URL*]
+`--mathjax`[`=`*URL*]
+
: Use [MathJax] to display embedded TeX math in HTML output.
The *URL* should point to the `MathJax.js` load script.
If a *URL* is not provided, a link to the MathJax CDN will
be inserted.
`--gladtex`
+
: Enclose TeX math in `<eq>` tags in HTML output. These can then
be processed by [gladTeX] to produce links to images of the typeset
formulas.
-`--mimetex`[=*URL*]
+`--mimetex`[`=`*URL*]
+
: Render TeX math using the [mimeTeX] CGI script. If *URL* is not
specified, it is assumed that the script is at `/cgi-bin/mimetex.cgi`.
-`--webtex`[=*URL*]
+`--webtex`[`=`*URL*]
+
: Render TeX formulas using an external script that converts TeX
formulas to images. The formula will be concatenated with the URL
provided. If *URL* is not specified, the Google Chart API will be used.
-`--katex`[=*URL*]
-: Use [KaTeX] to display embedded TeX math in HTML output.
- The *URL* should point to the `katex.js` load script. If a *URL* is
- not provided, a link to the KaTeX CDN will be inserted.
+`--katex`[`=`*URL*]
+
+: Use [KaTeX] to display embedded TeX math in HTML output.
+ The *URL* should point to the `katex.js` load script. If a *URL* is
+ not provided, a link to the KaTeX CDN will be inserted.
+
+`--katex-stylesheet=`*URL*
-`--katex-stylesheet=*URL*`
-: The *URL* should point to the `katex.css` stylesheet. If this option is
- not specified, a link to the KaTeX CDN will be inserted. Note that this
- option does not imply `--katex`.
+: The *URL* should point to the `katex.css` stylesheet. If this option is
+ not specified, a link to the KaTeX CDN will be inserted. Note that this
+ option does not imply `--katex`.
Options for wrapper scripts
---------------------------
`--dump-args`
+
: Print information about command-line arguments to *stdout*, then exit.
This option is intended primarily for use in wrapper scripts.
The first line of output contains the name of the output file specified
@@ -734,6 +860,7 @@ Options for wrapper scripts
after a `--` separator at the end of the line.
`--ignore-args`
+
: Ignore command-line arguments (for use in wrapper scripts).
Regular Pandoc options are not ignored. Thus, for example,
@@ -847,9 +974,10 @@ as `title`, `author`, and `date`) as well as the following:
`libertine` (Linux Libertine), `arev` (Arev Sans),
and the default `lmodern`, among others.
-`mainfont`, `sansfont`, `monofont`, `mathfont`
+`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
: fonts for LaTeX documents (works only with xelatex
- and lualatex)
+ and lualatex). Note that if `CJKmainfont` is used,
+ the `xeCJK` package must be available.
`colortheme`
: colortheme for LaTeX beamer documents
@@ -861,6 +989,9 @@ as `title`, `author`, and `date`) as well as the following:
: color for internal links in LaTeX documents (`red`, `green`,
`magenta`, `cyan`, `blue`, `black`)
+`toccolor`
+: color for links in table of contents in LaTeX documents
+
`urlcolor`
: color for external links in LaTeX documents
@@ -876,18 +1007,21 @@ as `title`, `author`, and `date`) as well as the following:
`toc-depth`
: level of section to include in table of contents in LaTeX documents
+`toc-title`
+: title of table of contents (works only with EPUB and docx)
+
`lof`
: include list of figures in LaTeX documents
`lot`
: include list of tables in LaTeX documents
+`bibliography`
+: bibliography to use for resolving references
+
`biblio-style`
: bibliography style in LaTeX, when used with `--natbib`
-`biblio-files`
-: bibliography files to use in LaTeX, with `--natbib` or `--biblatex`
-
`section`
: section number in man pages
@@ -976,7 +1110,7 @@ footnotes.
Paragraphs
----------
-A paragraph is one or more lines of text followed by one or more blank line.
+A paragraph is one or more lines of text followed by one or more blank lines.
Newlines are treated as spaces, so you can reflow your paragraphs as you like.
If you need a hard line break, put two or more spaces at the end of a line.
@@ -1033,7 +1167,7 @@ wrapping). Consider, for example:
#22, for example, and #5.
-### Header identifiers in HTML, LaTeX, and ConTeXt ###
+### Header identifiers ###
#### Extension: `header_attributes` ####
@@ -1143,10 +1277,17 @@ If there are multiple headers with identical text, the corresponding
reference will link to the first one only, and you will need to use explicit
links to link to the others, as described above.
-Unlike regular reference links, these references are case-sensitive.
+Like regular reference links, these references are case-insensitive.
+
+Explicit link reference definitions always take priority over
+implicit header references. So, in the following example, the
+link will point to `bar`, not to `#foo`:
-Note: if you have defined an explicit identifier for a header,
-then implicit references to it will not work.
+ # Foo
+
+ [foo]: bar
+
+ See [foo]
Block quotations
----------------
@@ -1217,9 +1358,9 @@ Note: blank lines in the verbatim text need not begin with four spaces.
In addition to standard indented code blocks, Pandoc supports
*fenced* code blocks. These begin with a row of three or more
-tildes (`~`) or backticks (`` ` ``) and end with a row of tildes or
-backticks that must be at least as long as the starting row. Everything
-between these lines is treated as code. No indentation is necessary:
+tildes (`~`) and end with a row of tildes that must be at least as long as
+the starting row. Everything between these lines is treated as code. No
+indentation is necessary:
~~~~~~~
if (a > 3) {
@@ -1239,9 +1380,14 @@ row of tildes or backticks at the start and end:
~~~~~~~~~~
~~~~~~~~~~~~~~~~
+#### Extension: `backtick_code_blocks` ####
+
+Same as `fenced_code_blocks`, but uses backticks (`` ` ``) instead of tildes
+(`~`).
+
#### Extension: `fenced_code_attributes` ####
-Optionally, you may attach attributes to the code block using
+Optionally, you may attach attributes to fenced or backtick code block using
this syntax:
~~~~ {#mycode .haskell .numberLines startFrom="100"}
@@ -1284,6 +1430,8 @@ word.
To prevent all highlighting, use the `--no-highlight` flag.
To set the highlighting style, use `--highlight-style`.
+For more information on highlighting, see [Syntax highlighting],
+below.
Line blocks
-----------
@@ -1800,8 +1948,8 @@ Pipe tables look like this:
The syntax is [the same as in PHP markdown extra]. The beginning and
ending pipe characters are optional, but pipes are required between all
columns. The colons indicate column alignment as shown. The header
-can be omitted, but the horizontal line must still be included, as
-it defines column alignments.
+cannot be omitted. To simulate a headerless table, include a header
+with blank cells.
Since the pipes indicate column boundaries, columns need not be vertically
aligned, as they are in the above example. So, this is a perfectly
@@ -1823,7 +1971,7 @@ to wrap within cells, use multiline or grid tables.
http://michelf.ca/projects/php-markdown/extra/#table
Note: Pandoc also recognizes pipe tables of the following
-form, as can produced by Emacs' orgtbl-mode:
+form, as can be produced by Emacs' orgtbl-mode:
| One | Two |
|-----+-------|
@@ -1938,6 +2086,11 @@ A document may contain multiple metadata blocks. The metadata fields will
be combined through a *left-biased union*: if two metadata blocks attempt
to set the same field, the value from the first block will be taken.
+When pandoc is used with `-t markdown` to create a markdown document,
+a YAML metadata block will be produced only if the `-s/--standalone`
+option is used. All of the metadata will appear in a single block
+at the beginning of the document.
+
Note that YAML escaping rules must be followed. Thus, for example,
if a title contains a colon, it must be quoted. The pipe character
(`|`) can be used to begin an indented block that will be interpreted
@@ -2146,7 +2299,7 @@ Markdown, LaTeX, Org-Mode, ConTeXt
reStructuredText
~ It will be rendered using an interpreted text role `:math:`, as described
- [here](http://www.american.edu/econ/itex2mml/mathhack.rst).
+ [here](http://docutils.sourceforge.net/docs/ref/rst/roles.html#math)
AsciiDoc
~ It will be rendered as `latexmath:[...]`.
@@ -2256,19 +2409,19 @@ by default, pandoc interprets material between HTML block tags as markdown.
Thus, for example, Pandoc will turn
<table>
- <tr>
- <td>*one*</td>
- <td>[a link](http://google.com)</td>
- </tr>
+ <tr>
+ <td>*one*</td>
+ <td>[a link](http://google.com)</td>
+ </tr>
</table>
into
<table>
- <tr>
- <td><em>one</em></td>
- <td><a href="http://google.com">a link</a></td>
- </tr>
+ <tr>
+ <td><em>one</em></td>
+ <td><a href="http://google.com">a link</a></td>
+ </tr>
</table>
whereas `Markdown.pl` will preserve it as is.
@@ -2365,6 +2518,10 @@ be followed by a link title, in quotes.)
There can be no space between the bracketed part and the parenthesized part.
The link text can contain formatting (such as emphasis), but the title cannot.
+Email addresses in inline links are not autodetected, so they have to be
+prefixed with `mailto`:
+
+ [Write me!](mailto:sam@green.eggs.ham)
### Reference links ###
@@ -2376,7 +2533,9 @@ The link consists of link text in square brackets, followed by a label in
square brackets. (There can be space between the two.) The link definition
consists of the bracketed label, followed by a colon and a space, followed by
the URL, and optionally (after a space) a link title either in quotes or in
-parentheses.
+parentheses. The label must not be parseable as a citation (assuming
+the `citations` extension is enabled): citations take precedence over
+link labels.
Here are some examples:
@@ -2401,9 +2560,9 @@ Note that link labels are not case sensitive. So, this will work:
[Foo]: /bar/baz
In an *implicit* reference link, the second pair of brackets is
-empty, or omitted entirely:
+empty:
- See [my website][], or [my website].
+ See [my website][].
[my website]: http://foo.bar.baz
@@ -2417,12 +2576,20 @@ not in most other implementations:
>
> [quote]: /foo
+#### Extension: `shortcut_reference_links` ####
+
+In a *shortcut* reference link, the second pair of brackets may
+be omitted entirely:
+
+ See [my website].
+
+ [my website]: http://foo.bar.baz
+
### Internal links ###
To link to another section of the same document, use the automatically
-generated identifier (see [Header identifiers in HTML, LaTeX, and
-ConTeXt](#header-identifiers-in-html-latex-and-context), below).
-For example:
+generated identifier (see [Header identifiers](#header-identifiers),
+below). For example:
See the [Introduction](#introduction).
@@ -2525,64 +2692,84 @@ citations and a bibliography in a number of styles. Basic usage is
pandoc --filter pandoc-citeproc myinput.txt
In order to use this feature, you will need to specify a bibliography file
-using the `bibliography` metadata field in a YAML metadata section.
+using the `bibliography` metadata field in a YAML metadata section, or
+`--bibliography` command line argument. You can supply multiple `--bibliography`
+arguments or set `bibliography` metadata field to YAML array, if you want to
+use multiple bibliography files.
The bibliography may have any of these formats:
Format File extension
------------ --------------
- MODS .mods
BibLaTeX .bib
BibTeX .bibtex
- RIS .ris
+ Copac .copac
+ CSL JSON .json
+ CSL YAML .yaml
EndNote .enl
EndNote XML .xml
ISI .wos
MEDLINE .medline
- Copac .copac
- JSON citeproc .json
+ MODS .mods
+ RIS .ris
Note that `.bib` can generally be used with both BibTeX and BibLaTeX
files, but you can use `.bibtex` to force BibTeX.
-Alternatively you can use a `references` field in the document's YAML
-metadata. This should include an array of YAML-encoded references,
-for example:
+Note that `pandoc-citeproc --bib2json` and `pandoc-citeproc --bib2yaml`
+can produce `.json` and `.yaml` files from any of the supported formats.
+
+In-field markup: In bibtex and biblatex databases, pandoc-citeproc parses
+(a subset of) LaTeX markup; in CSL JSON databases, an HTML-like markup
+([specs](http://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields));
+and in CSL YAML databases, pandoc markdown. `pandoc-citeproc -j` and `-y`
+interconvert these markup formats as far as possible.
+
+As an alternative to specifying a bibliography file, you can include
+the citation data directly in the `references` field of the
+document's YAML metadata. The field should contain an array of
+YAML-encoded references, for example:
---
references:
- - id: fenner2012a
- title: One-click science marketing
+ - type: article-journal
+ id: WatsonCrick1953
author:
- - family: Fenner
- given: Martin
- container-title: Nature Materials
- volume: 11
- URL: 'http://dx.doi.org/10.1038/nmat3283'
- DOI: 10.1038/nmat3283
- issue: 4
- publisher: Nature Publishing Group
- page: 261-263
- type: article-journal
+ - family: Watson
+ given: J. D.
+ - family: Crick
+ given: F. H. C.
issued:
- year: 2012
- month: 3
+ date-parts:
+ - - 1953
+ - 4
+ - 25
+ title: 'Molecular structure of nucleic acids: a structure for deoxyribose
+ nucleic acid'
+ title-short: Molecular structure of nucleic acids
+ container-title: Nature
+ volume: 171
+ issue: 4356
+ page: 737-738
+ DOI: 10.1038/171737a0
+ URL: http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html
+ language: en-GB
...
-(The program `mods2yaml`, which comes with `pandoc-citeproc`, can help produce
-these from a MODS reference collection.)
+(`pandoc-citeproc --bib2yaml` can produce these from a bibliography file in one
+of the supported formats.)
-By default, `pandoc-citeproc` will use a Chicago author-date format for
-citations and references. To use another style, you will need to specify
-a [CSL] 1.0 style file in the `csl` metadata field. A primer on creating and
+By default, `pandoc-citeproc` will use the Chicago Manual of Style author-date
+format for citations and references. To use another style, you will need to
+specify a [CSL] 1.0 style file in the `csl` metadata field. A repository of CSL
+styles can be found at <https://github.com/citation-style-language/styles>. See
+also <http://zotero.org/styles> for easy browsing. A primer on creating and
modifying CSL styles can be found at
-<http://citationstyles.org/downloads/primer.html>. A repository of CSL styles
-can be found at <https://github.com/citation-style-language/styles>. See also
-<http://zotero.org/styles> for easy browsing.
+<http://citationstyles.org/downloads/primer.html>.
Citations go inside square brackets and are separated by semicolons.
Each citation must have a key, composed of '@' + the citation
identifier from the database, and may optionally have a prefix,
-a locator, and a suffix. The citation key must begin with a letter
+a locator, and a suffix. The citation key must begin with a letter, digit,
or `_`, and may contain alphanumerics, `_`, and internal punctuation
characters (`:.#$%&-+?<>~/`). Here are some examples:
@@ -2631,6 +2818,12 @@ In this example, the document will contain a citation for `item3`
only, but the bibliography will contain entries for `item1`, `item2`, and
`item3`.
+For LaTeX or PDF output, you can also use NatBib or BibLaTeX
+to render bibliography. In order to do so, specify bibliography files as
+outlined above, and add `--natbib` or `--biblatex` argument to `pandoc`
+invocation. Bear in mind that bibliography files have to be in respective
+format (either BibTeX or BibLaTeX).
+
Non-pandoc extensions
---------------------
@@ -2760,20 +2953,22 @@ variants are supported:
`markdown_phpextra` (PHP Markdown Extra)
: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,
`fenced_code_blocks`, `definition_lists`, `intraword_underscores`,
- `header_attributes`, `abbreviations`.
+ `header_attributes`, `abbreviations`, `shortcut_reference_links`.
-`markdown_github` (Github-flavored Markdown)
+`markdown_github` (GitHub-flavored Markdown)
: `pipe_tables`, `raw_html`, `tex_math_single_backslash`,
`fenced_code_blocks`, `auto_identifiers`,
`ascii_identifiers`, `backtick_code_blocks`, `autolink_bare_uris`,
- `intraword_underscores`, `strikeout`, `hard_line_breaks`
+ `intraword_underscores`, `strikeout`, `hard_line_breaks`,
+ `shortcut_reference_links`.
`markdown_mmd` (MultiMarkdown)
: `pipe_tables` `raw_html`, `markdown_attribute`, `link_attributes`,
`raw_tex`, `tex_math_double_backslash`, `intraword_underscores`,
`mmd_title_block`, `footnotes`, `definition_lists`,
`all_symbols_escapable`, `implicit_header_references`,
- `auto_identifiers`, `mmd_header_identifiers`
+ `auto_identifiers`, `mmd_header_identifiers`,
+ `shortcut_reference_links`.
`markdown_strict` (Markdown.pl)
: `raw_html`
@@ -2902,7 +3097,7 @@ you use deeper nesting of section levels with reveal.js.
Incremental lists
-----------------
-By default, these writers produces lists that display "all at once."
+By default, these writers produce lists that display "all at once."
If you want your lists to display incrementally (one item at a time),
use the `-i` option. If you want a particular list to depart from the
default (that is, to display incrementally without the `-i` option and
@@ -2982,6 +3177,16 @@ To show the notes window, press `s` while viewing the presentation.
Notes are not yet supported for other slide formats, but the notes
will not appear on the slides themselves.
+Marking frames "fragile" in beamer
+----------------------------------
+
+Sometimes it is necessary to add the LaTeX `[fragile]` option to
+a frame in beamer (for example, when using the `minted` environment).
+This can be forced by adding the `fragile` class to the header
+introducing the slide:
+
+ # Fragile slide {.fragile}
+
EPUB Metadata
=============
@@ -3117,6 +3322,24 @@ ordinary HTML (without bird tracks).
writes HTML with the Haskell code in bird tracks, so it can be copied
and pasted as literate Haskell source.
+Syntax highlighting
+===================
+
+Pandoc will automatically highlight syntax in fenced code blocks that
+are marked with a language name. (See [Extension:
+`inline_code_attributes`] and [Extension: `fenced_code_attributes`],
+above.) The Haskell library [highlighting-kate] is used for
+highlighting, which works in HTML, Docx, and LaTeX/PDF output.
+The color scheme can be selected using the `--highlight-style` option.
+The default color scheme is `pygments`, which imitates the default color
+scheme used by the Python library pygments, but pygments is not actually
+used to do the highlighting.
+
+To see a list of language names that pandoc will recognize, type
+`pandoc --version`.
+
+To disable highlighting, use the `--no-highlight` option.
+
Custom writers
==============
@@ -3137,18 +3360,135 @@ which you can modify according to your needs, do
Authors
=======
-© 2006-2013 John MacFarlane (jgm at berkeley dot edu). Released under the
+© 2006-2015 John MacFarlane (jgm@berkeley.edu). Released under the
[GPL], version 2 or greater. This software carries no warranty of
any kind. (See COPYRIGHT for full copyright and warranty notices.)
-Other contributors include Recai Oktaş, Paulo Tanimoto, Peter Wang,
-Andrea Rossato, Eric Kow, infinity0x, Luke Plant, shreevatsa.public,
-Puneeth Chaganti, Paul Rivier, rodja.trappe, Bradley Kuhn, thsutton,
-Nathan Gass, Jonathan Daugherty, Jérémy Bobbio, Justin Bogner, qerub,
-Christopher Sawicki, Kelsey Hightower, Masayoshi Takahashi, Antoine
-Latter, Ralf Stephan, Eric Seidel, B. Scott Michel, Gavin Beatty,
-Sergey Astanin, Arlo O'Keeffe, Denis Laxalde, Brent Yorgey, David Lazar,
-Jamie F. Olson, Matthew Pickering, Albert Krewinkel, mb21, Jesse
-Rosenthal.
+
+Contributors include
+Aaron Wolen,
+Albert Krewinkel,
+Alexander Kondratskiy,
+Alexander Sulfrian,
+Alexander V Vershilov,
+Alfred Wechselberger,
+Andreas Lööw,
+Andrew Dunning,
+Antoine Latter,
+Arlo O'Keeffe,
+Artyom Kazak,
+Ben Gamari,
+Beni Cherniavsky-Paskin,
+Bjorn Buckwalter,
+Bradley Kuhn,
+Brent Yorgey,
+Bryan O'Sullivan,
+B. Scott Michel,
+Caleb McDaniel,
+Calvin Beck,
+Christoffer Ackelman,
+Christoffer Sawicki,
+Clare Macrae,
+Clint Adams,
+Conal Elliott,
+Craig S. Bosma,
+Daniel Bergey,
+Daniel T. Staal,
+David Lazar,
+David Röthlisberger,
+Denis Laxalde,
+Douglas Calvert,
+Douglas F. Calvert,
+Eric Kow,
+Eric Seidel,
+Florian Eitel,
+François Gannaz,
+Freiric Barral,
+Fyodor Sheremetyev,
+Gabor Pali,
+Gavin Beatty,
+Greg Maslov,
+Grégory Bataille,
+Greg Rundlett,
+gwern,
+Gwern Branwen,
+Hans-Peter Deifel,
+Henry de Valence,
+Ilya V. Portnov,
+infinity0x,
+Jaime Marquínez Ferrándiz,
+James Aspnes,
+Jamie F. Olson,
+Jan Larres,
+Jason Ronallo,
+Jeff Arnold,
+Jeff Runningen,
+Jens Petersen,
+Jérémy Bobbio,
+Jesse Rosenthal,
+J. Lewis Muir,
+Joe Hillenbrand,
+John MacFarlane,
+Jonas Smedegaard,
+Jonathan Daugherty,
+Josef Svenningsson,
+Jose Luis Duran,
+Julien Cretel,
+Justin Bogner,
+Kelsey Hightower,
+Konstantin Zudov,
+Lars-Dominik Braun,
+Luke Plant,
+Mark Szepieniec,
+Mark Wright,
+Masayoshi Takahashi,
+Matej Kollar,
+Mathias Schenner,
+Matthew Pickering,
+Matthias C. M. Troffaes,
+Max Bolingbroke,
+Max Rydahl Andersen,
+mb21,
+Merijn Verstraaten,
+Michael Snoyman,
+Michael Thompson,
+MinRK,
+Nathan Gass,
+Neil Mayhew,
+Nick Bart,
+Nicolas Kaiser,
+Nikolay Yakimov,
+nkalvi,
+Paulo Tanimoto,
+Paul Rivier,
+Peter Wang,
+Philippe Ombredanne,
+Phillip Alday,
+Puneeth Chaganti,
+qerub,
+Ralf Stephan,
+Recai Oktaş,
+rodja.trappe,
+RyanGlScott,
+Scott Morrison,
+Sergei Trofimovich,
+Sergey Astanin,
+Shahbaz Youssefi,
+Shaun Attfield,
+shreevatsa.public,
+Simon Hengel,
+Sumit Sahrawat,
+takahashim,
+thsutton,
+Tim Lin,
+Timothy Humphries,
+Todd Sifleet,
+Tom Leese,
+Uli Köhler,
+Václav Zeman,
+Viktor Kronvall,
+Vincent,
+Wikiwide, and
+Xavier Olive.
[markdown]: http://daringfireball.net/projects/markdown/
[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html
@@ -3169,6 +3509,7 @@ Rosenthal.
[Textile]: http://redcloth.org/textile
[MediaWiki markup]: http://www.mediawiki.org/wiki/Help:Formatting
[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
+[TWiki markup]: http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
[Haddock markup]: http://www.haskell.org/haddock/doc/html/ch03s08.html
[groff man]: http://developer.apple.com/DOCUMENTATION/Darwin/Reference/ManPages/man7/groff_man.7.html
[Haskell]: http://www.haskell.org/
@@ -3190,3 +3531,5 @@ Rosenthal.
[EPUB]: http://idpf.org/epub
[EPUBspine]: http://www.idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
[KaTeX]: https://github.com/Khan/KaTeX
+[CommonMark]: http://commonmark.org
+[highlighting-kate]: http://github.com/jgm/highlighting-kate