8pandoc [*options*] [*input-file*]...
13Pandoc is a [Haskell] library for converting from one markup format to
14another, and a command-line tool that uses this library. It can read
15[markdown] and (subsets of) [Textile], [reStructuredText], [HTML],
16[LaTeX], [MediaWiki markup], [Haddock markup], [OPML], [Emacs
17Org-mode], [DocBook], [txt2tags] and [Word docx]; and it can write plain text,
18[markdown], [reStructuredText], [XHTML], [HTML 5], [LaTeX] (including
19[beamer] slide shows), [ConTeXt], [RTF], [OPML], [DocBook],
20[OpenDocument], [ODT], [Word docx], [GNU Texinfo], [MediaWiki markup],
21[DokuWiki markup], [Haddock markup], [EPUB] (v2 or v3), [FictionBook2],
22[Textile], [groff man] pages, [Emacs Org-Mode], [AsciiDoc], [InDesign ICML],
23and [Slidy], [Slideous], [DZSlides], [reveal.js] or [S5] HTML slide shows.
24It can also produce [PDF] output on systems where LaTeX is installed.
26Pandoc's enhanced version of markdown includes syntax for footnotes,
27tables, flexible ordered lists, definition lists, fenced code blocks,
28superscript, subscript, strikeout, title blocks, automatic tables of
29contents, embedded LaTeX math, citations, and markdown inside HTML block
30elements. (These enhancements, described below under
31[Pandoc's markdown](#pandocs-markdown), can be disabled using the
32`markdown_strict` input or output format.)
34In contrast to most existing tools for converting markdown to HTML, which
35use regex substitutions, Pandoc has a modular design: it consists of a
36set of readers, which parse text in a given format and produce a native
37representation of the document, and a set of writers, which convert
38this native representation into a target format. Thus, adding an input
39or output format requires only adding a reader or writer.
44If no *input-file* is specified, input is read from *stdin*.
45Otherwise, the *input-files* are concatenated (with a blank
46line between each) and used as input. Output goes to *stdout* by
47default (though output to *stdout* is disabled for the `odt`, `docx`,
48`epub`, and `epub3` output formats). For output to a file, use the
51 pandoc -o output.html input.txt
53Instead of a file, an absolute URI may be given. In this case
54pandoc will fetch the content using HTTP:
56 pandoc -f html -t markdown http://www.fsf.org
58If multiple input files are given, `pandoc` will concatenate them all (with
59blank lines between them) before parsing.
61The format of the input and output can be specified explicitly using
62command-line options. The input format can be specified using the
63`-r/--read` or `-f/--from` options, the output format using the
64`-w/--write` or `-t/--to` options. Thus, to convert `hello.txt` from
65markdown to LaTeX, you could type:
67 pandoc -f markdown -t latex hello.txt
69To convert `hello.html` from html to markdown:
71 pandoc -f html -t markdown hello.html
73Supported output formats are listed below under the `-t/--to` option.
74Supported input formats are listed below under the `-f/--from` option. Note
75that the `rst`, `textile`, `latex`, and `html` readers are not complete;
76there are some constructs that they do not parse.
78If the input or output format is not specified explicitly, `pandoc`
79will attempt to guess it from the extensions of
80the input and output filenames. Thus, for example,
82 pandoc -o hello.tex hello.txt
84will convert `hello.txt` from markdown to LaTeX. If no output file
85is specified (so that output goes to *stdout*), or if the output file's
86extension is unknown, the output format will default to HTML.
87If no input file is specified (so that input comes from *stdin*), or
88if the input files' extensions are unknown, the input format will
89be assumed to be markdown unless explicitly specified.
91Pandoc uses the UTF-8 character encoding for both input and output.
92If your local character encoding is not UTF-8, you
93should pipe input and output through `iconv`:
95 iconv -t utf-8 input.txt | pandoc | iconv -f utf-8
100Earlier versions of pandoc came with a program, `markdown2pdf`, that
101used pandoc and pdflatex to produce a PDF. This is no longer needed,
102since `pandoc` can now produce `pdf` output itself. To produce a PDF, simply
103specify an output file with a `.pdf` extension. Pandoc will create a latex
104file and use pdflatex (or another engine, see `--latex-engine`) to convert it
107 pandoc test.txt -o test.pdf
109Production of a PDF requires that a LaTeX engine be installed (see
110`--latex-engine`, below), and assumes that the following LaTeX packages are
111available: `amssymb`, `amsmath`, `ifxetex`, `ifluatex`, `listings` (if the
112`--listings` option is used), `fancyvrb`, `longtable`, `booktabs`, `url`,
113`graphicx`, `hyperref`, `ulem`, `babel` (if the `lang` variable is set),
114`fontspec` (if `xelatex` or `lualatex` is used as the LaTeX engine), `xltxtra`
115and `xunicode` (if `xelatex` is used).
120A user who wants a drop-in replacement for `Markdown.pl` may create
121a symbolic link to the `pandoc` executable called `hsmarkdown`. When
122invoked under the name `hsmarkdown`, `pandoc` will behave as if
123invoked with `-f markdown_strict --email-obfuscation=references`,
124and all command-line options will be treated as regular arguments.
125However, this approach does not work under Cygwin, due to problems with
126its simulation of symbolic links.
128[Cygwin]: http://www.cygwin.com/
129[`iconv`]: http://www.gnu.org/software/libiconv/
130[CTAN]: http://www.ctan.org "Comprehensive TeX Archive Network"
131[TeX Live]: http://www.tug.org/texlive/
132[MacTeX]: http://www.tug.org/mactex/
140`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*
141: Specify input format. *FORMAT* can be `native` (native Haskell),
142 `json` (JSON version of native AST), `markdown` (pandoc's
143 extended markdown), `markdown_strict` (original unextended markdown),
144 `markdown_phpextra` (PHP Markdown Extra extended markdown),
145 `markdown_github` (github extended markdown),
146 `textile` (Textile), `rst` (reStructuredText), `html` (HTML),
147 `docbook` (DocBook), `t2t` (txt2tags), `opml` (OPML), `org` (Emacs
148 Org-mode), `mediawiki` (MediaWiki markup), `haddock` (Haddock markup),
149 or `latex` (LaTeX). If `+lhs` is appended to `markdown`, `rst`,
150 `latex`, or `html`, the input will be treated as literate Haskell
151 source: see [Literate Haskell support](#literate-haskell-support),
152 below. Markdown syntax extensions can be individually enabled or
153 disabled by appending `+EXTENSION` or `-EXTENSION` to the format
154 name. So, for example, `markdown_strict+footnotes+definition_lists`
155 is strict markdown with footnotes and definition lists enabled,
156 and `markdown-pipe_tables+hard_line_breaks` is pandoc's markdown
157 without pipe tables and with hard line breaks. See [Pandoc's
158 markdown](#pandocs-markdown), below, for a list of extensions and
161`-t` *FORMAT*, `-w` *FORMAT*, `--to=`*FORMAT*, `--write=`*FORMAT*
162: Specify output format. *FORMAT* can be `native` (native Haskell),
163 `json` (JSON version of native AST), `plain` (plain text),
164 `markdown` (pandoc's extended markdown), `markdown_strict` (original
165 unextended markdown), `markdown_phpextra` (PHP Markdown extra
166 extended markdown), `markdown_github` (github extended markdown),
167 `rst` (reStructuredText), `html` (XHTML 1), `html5` (HTML 5),
168 `latex` (LaTeX), `beamer` (LaTeX beamer slide show),
169 `context` (ConTeXt), `man` (groff man), `mediawiki` (MediaWiki markup),
170 `dokuwiki` (DokuWiki markup),
171 `textile` (Textile), `org` (Emacs Org-Mode), `texinfo` (GNU Texinfo),
172 `opml` (OPML), `docbook` (DocBook), `opendocument` (OpenDocument), `odt`
173 (OpenOffice text document), `docx` (Word docx), `haddock` (Haddock
174 markup), `rtf` (rich text format), `epub` (EPUB v2 book), `epub3`
175 (EPUB v3), `fb2` (FictionBook2 e-book), `asciidoc` (AsciiDoc),
176 `icml` (InDesign ICML), `slidy` (Slidy HTML and javascript slide show),
177 `slideous` (Slideous HTML and javascript slide show), `dzslides`
178 (DZSlides HTML5 + javascript slide show), `revealjs` (reveal.js
179 HTML5 + javascript slide show), `s5` (S5 HTML and javascript slide show),
180 or the path of a custom lua writer (see [Custom writers](#custom-writers),
181 below). Note that `odt`, `epub`, and `epub3` output will not be directed
182 to *stdout*; an output filename must be specified using the `-o/--output`
183 option. If `+lhs` is appended to `markdown`, `rst`, `latex`, `beamer`,
184 `html`, or `html5`, the output will be rendered as literate Haskell
185 source: see [Literate Haskell support](#literate-haskell-support), below.
186 Markdown syntax extensions can be individually enabled or disabled by
187 appending `+EXTENSION` or `-EXTENSION` to the format name, as described
190`-o` *FILE*, `--output=`*FILE*
191: Write output to *FILE* instead of *stdout*. If *FILE* is
192 `-`, output will go to *stdout*. (Exception: if the output
193 format is `odt`, `docx`, `epub`, or `epub3`, output to stdout is disabled.)
195`--data-dir=`*DIRECTORY*
196: Specify the user data directory to search for pandoc data files.
197 If this option is not specified, the default user data directory
198 will be used. This is
204 C:\Documents And Settings\USERNAME\Application Data\pandoc
208 C:\Users\USERNAME\AppData\Roaming\pandoc
210 in Windows 7. (You can find the default user data directory
211 on your system by looking at the output of `pandoc --version`.)
212 A `reference.odt`, `reference.docx`, `default.csl`,
213 `epub.css`, `templates`, `slidy`, `slideous`, or `s5` directory
214 placed in this directory will override pandoc's normal defaults.
226: Parse untranslatable HTML codes and LaTeX environments as raw HTML
227 or LaTeX, instead of ignoring them. Affects only HTML and LaTeX
228 input. Raw HTML can be printed in markdown, reStructuredText, HTML,
229 Slidy, Slideous, DZSlides, reveal.js, and S5 output; raw LaTeX
230 can be printed in markdown, reStructuredText, LaTeX, and ConTeXt output.
231 The default is for the readers to omit untranslatable HTML codes and
232 LaTeX environments. (The LaTeX reader does pass through untranslatable
233 LaTeX *commands*, even if `-R` is not specified.)
236: Produce typographically correct output, converting straight quotes
237 to curly quotes, `---` to em-dashes, `--` to en-dashes, and
238 `...` to ellipses. Nonbreaking spaces are inserted after certain
239 abbreviations, such as "Mr." (Note: This option is significant only when
240 the input format is `markdown`, `markdown_strict`, or `textile`. It
241 is selected automatically when the input format is `textile` or the
242 output format is `latex` or `context`, unless `--no-tex-ligatures`
246: Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes: `-` before
247 a numeral is an en-dash, and `--` is an em-dash. This option is selected
248 automatically for `textile` input.
250`--base-header-level=`*NUMBER*
251: Specify the base level for headers (defaults to 1).
253`--indented-code-classes=`*CLASSES*
254: Specify classes to use for indented code blocks--for example,
255 `perl,numberLines` or `haskell`. Multiple classes may be separated
258`--default-image-extension=`*EXTENSION*
259: Specify a default extension to use when image paths/URLs have no
260 extension. This allows you to use the same source for formats that
261 require different kinds of images. Currently this option only affects
262 the markdown and LaTeX readers.
264`--filter=`*EXECUTABLE*
265: Specify an executable to be used as a filter transforming the
266 Pandoc AST after the input is parsed and before the output is
267 written. The executable should read JSON from stdin and write
268 JSON to stdout. The JSON must be formatted like pandoc's own
269 JSON input and output. The name of the output format will be
270 passed to the filter as the first argument. Hence,
272 pandoc --filter ./caps.py -t latex
276 pandoc -t json | ./caps.py latex | pandoc -f json -t latex
278 The latter form may be useful for debugging filters.
280 Filters may be written in any language. `Text.Pandoc.JSON`
281 exports `toJSONFilter` to facilitate writing filters in Haskell.
282 Those who would prefer to write filters in python can use the
283 module `pandocfilters`, installable from PyPI. See
284 <http://github.com/jgm/pandocfilters> for the module and several
285 examples. Note that the *EXECUTABLE* will be sought in the user's
286 `PATH`, and not in the working directory, if no directory is
287 provided. If you want to run a script in the working directory,
288 preface the filename with `./`.
290`-M` *KEY[=VAL]*, `--metadata=`*KEY[:VAL]*
291: Set the metadata field *KEY* to the value *VAL*. A value specified
292 on the command line overrides a value specified in the document.
293 Values will be parsed as YAML boolean or string values. If no value is
294 specified, the value will be treated as Boolean true. Like
295 `--variable`, `--metadata` causes template variables to be set.
296 But unlike `--variable`, `--metadata` affects the metadata of the
297 underlying document (which is accessible from filters and may be
298 printed in some output formats).
301: Normalize the document after reading: merge adjacent
302 `Str` or `Emph` elements, for example, and remove repeated `Space`s.
304`-p`, `--preserve-tabs`
305: Preserve tabs instead of converting them to spaces (the default).
306 Note that this will only affect tabs in literal code spans and code
307 blocks; tabs in regular text will be treated as spaces.
310: Specify the number of spaces per tab (default is 4).
312`--track-changes=`*accept|reject|all*
313: Specifies what to do with insertions and deletions produced by the MS
314 Word "track-changes" feature. *accept* (the default), inserts all
315 insertions, and ignores all deletions. *reject* inserts all
316 deletions and ignores insertions. *all* puts in both insertions
317 and deletions, wrapped in spans with `insertion` and `deletion`
318 classes, respectively. The author and time of change is
319 included. *all* is useful for scripting: only accepting changes
320 from a certain reviewer, say, or before a certain date. This
321 option only affects the docx reader.
323`--extract-media=`*DIR*
324: Extract images and other media contained in a docx or epub container
325 to the path *DIR*, creating it if necessary, and adjust the images
326 references in the document so they point to the extracted files.
327 This option only affects the docx and epub readers.
329General writer options
330----------------------
333: Produce output with an appropriate header and footer (e.g. a
334 standalone HTML, LaTeX, or RTF file, not a fragment). This option
335 is set automatically for `pdf`, `epub`, `epub3`, `fb2`, `docx`, and `odt`
339: Use *FILE* as a custom template for the generated document. Implies
340 `--standalone`. See [Templates](#templates) below for a description
341 of template syntax. If no extension is specified, an extension
342 corresponding to the writer will be added, so that `--template=special`
343 looks for `special.html` for HTML output. If the template is not
344 found, pandoc will search for it in the user data directory
345 (see `--data-dir`). If this option is not used, a default
346 template appropriate for the output format will be used (see
347 `-D/--print-default-template`).
349`-V` *KEY[=VAL]*, `--variable=`*KEY[:VAL]*
350: Set the template variable *KEY* to the value *VAL* when rendering the
351 document in standalone mode. This is generally only useful when the
352 `--template` option is used to specify a custom template, since
353 pandoc automatically sets the variables used in the default
354 templates. If no *VAL* is specified, the key will be given the
357`-D` *FORMAT*, `--print-default-template=`*FORMAT*
358: Print the default template for an output *FORMAT*. (See `-t`
359 for a list of possible *FORMAT*s.)
361`--print-default-data-file=`*FILE*
362: Print a default data file.
365: Disable text wrapping in output. By default, text is wrapped
366 appropriately for the output format.
369: Specify length of lines in characters (for text wrapping).
371`--toc`, `--table-of-contents`
372: Include an automatically generated table of contents (or, in
373 the case of `latex`, `context`, and `rst`, an instruction to create
374 one) in the output document. This option has no effect on `man`,
375 `docbook`, `slidy`, `slideous`, `s5`, `docx`, or `odt` output.
377`--toc-depth=`*NUMBER*
378: Specify the number of section levels to include in the table
379 of contents. The default is 3 (which means that level 1, 2, and 3
380 headers will be listed in the contents).
383: Disables syntax highlighting for code blocks and inlines, even when
384 a language attribute is given.
386`--highlight-style`=*STYLE*
387: Specifies the coloring style to be used in highlighted source code.
388 Options are `pygments` (the default), `kate`, `monochrome`,
389 `espresso`, `zenburn`, `haddock`, and `tango`.
391`-H` *FILE*, `--include-in-header=`*FILE*
392: Include contents of *FILE*, verbatim, at the end of the header.
393 This can be used, for example, to include special
394 CSS or javascript in HTML documents. This option can be used
395 repeatedly to include multiple files in the header. They will be
396 included in the order specified. Implies `--standalone`.
398`-B` *FILE*, `--include-before-body=`*FILE*
399: Include contents of *FILE*, verbatim, at the beginning of the
400 document body (e.g. after the `<body>` tag in HTML, or the
401 `\begin{document}` command in LaTeX). This can be used to include
402 navigation bars or banners in HTML documents. This option can be
403 used repeatedly to include multiple files. They will be included in
404 the order specified. Implies `--standalone`.
406`-A` *FILE*, `--include-after-body=`*FILE*
407: Include contents of *FILE*, verbatim, at the end of the document
408 body (before the `</body>` tag in HTML, or the
409 `\end{document}` command in LaTeX). This option can be be used
410 repeatedly to include multiple files. They will be included in the
411 order specified. Implies `--standalone`.
413Options affecting specific writers
414----------------------------------
417: Produce a standalone HTML file with no external dependencies, using
418 `data:` URIs to incorporate the contents of linked scripts, stylesheets,
419 images, and videos. The resulting file should be "self-contained,"
420 in the sense that it needs no external files and no net access to be
421 displayed properly by a browser. This option works only with HTML output
422 formats, including `html`, `html5`, `html+lhs`, `html5+lhs`, `s5`,
423 `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images, and
424 stylesheets at absolute URLs will be downloaded; those at relative URLs
425 will be sought first relative to the working directory, then relative to
426 the user data directory (see `--data-dir`), and finally relative to
427 pandoc's default data directory. `--self-contained` does not
428 work with `--mathjax`.
431: Deprecated synonym for `--self-contained`.
434: Produce HTML5 instead of HTML4. This option has no effect for writers
435 other than `html`. (*Deprecated:* Use the `html5` output format instead.)
438: Use `<q>` tags for quotes in HTML.
441: Use only ascii characters in output. Currently supported only
442 for HTML output (which uses numerical entities instead of
443 UTF-8 when this option is selected).
446: Use reference-style links, rather than inline links, in writing markdown
447 or reStructuredText. By default inline links are used.
450: Use ATX style headers in markdown and asciidoc output. The default is
451 to use setext-style headers for levels 1-2, and then ATX headers.
454: Treat top-level headers as chapters in LaTeX, ConTeXt, and DocBook
455 output. When the LaTeX template uses the report, book, or
456 memoir class, this option is implied. If `beamer` is the output
457 format, top-level headers will become `\part{..}`.
459`-N`, `--number-sections`
460: Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.
461 By default, sections are not numbered. Sections with class
462 `unnumbered` will never be numbered, even if `--number-sections`
465`--number-offset`=*NUMBER[,NUMBER,...]*,
466: Offset for section headings in HTML output (ignored in other
467 output formats). The first number is added to the section number for
468 top-level headers, the second for second-level headers, and so on.
469 So, for example, if you want the first top-level header in your
470 document to be numbered "6", specify `--number-offset=5`.
471 If your document starts with a level-2 header which you want to
472 be numbered "1.5", specify `--number-offset=1,4`.
473 Offsets are 0 by default. Implies `--number-sections`.
476: Do not convert quotation marks, apostrophes, and dashes to
477 the TeX ligatures when writing LaTeX or ConTeXt. Instead, just
478 use literal unicode characters. This is needed for using advanced
479 OpenType features with XeLaTeX and LuaLaTeX. Note: normally
480 `--smart` is selected automatically for LaTeX and ConTeXt
481 output, but it must be specified explicitly if `--no-tex-ligatures`
482 is selected. If you use literal curly quotes, dashes, and ellipses
483 in your source, then you may want to use `--no-tex-ligatures`
487: Use listings package for LaTeX code blocks
490: Make list items in slide shows display incrementally (one by one).
491 The default is for lists to be displayed all at once.
493`--slide-level`=*NUMBER*
494: Specifies that headers with the specified level create
495 slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headers
496 above this level in the hierarchy are used to divide the
497 slide show into sections; headers below this level create
498 subheads within a slide. The default is to set the slide level
499 based on the contents of the document; see
500 [Structuring the slide show](#structuring-the-slide-show), below.
503: Wrap sections in `<div>` tags (or `<section>` tags in HTML5),
504 and attach identifiers to the enclosing `<div>` (or `<section>`)
505 rather than the header itself.
506 See [Section identifiers](#header-identifiers-in-html-latex-and-context), below.
508`--email-obfuscation=`*none|javascript|references*
509: Specify a method for obfuscating `mailto:` links in HTML documents.
510 *none* leaves `mailto:` links as they are. *javascript* obfuscates
511 them using javascript. *references* obfuscates them by printing their
512 letters as decimal or hexadecimal character references.
514`--id-prefix`=*STRING*
515: Specify a prefix to be added to all automatically generated identifiers
516 in HTML and DocBook output, and to footnote numbers in markdown output.
517 This is useful for preventing duplicate identifiers when generating
518 fragments to be included in other pages.
520`-T` *STRING*, `--title-prefix=`*STRING*
521: Specify *STRING* as a prefix at the beginning of the title
522 that appears in the HTML header (but not in the title as it
523 appears at the beginning of the HTML body). Implies
526`-c` *URL*, `--css=`*URL*
527: Link to a CSS style sheet. This option can be be used repeatedly to
528 include multiple files. They will be included in the order specified.
530`--reference-odt=`*FILE*
531: Use the specified file as a style reference in producing an ODT.
532 For best results, the reference ODT should be a modified version
533 of an ODT produced using pandoc. The contents of the reference ODT
534 are ignored, but its stylesheets are used in the new ODT. If no
535 reference ODT is specified on the command line, pandoc will look
536 for a file `reference.odt` in the user data directory (see
537 `--data-dir`). If this is not found either, sensible defaults will be
540`--reference-docx=`*FILE*
541: Use the specified file as a style reference in producing a docx file.
542 For best results, the reference docx should be a modified version
543 of a docx file produced using pandoc. The contents of the reference docx
544 are ignored, but its stylesheets and document properties (including
545 margins, page size, header, and footer) are used in the new docx. If no
546 reference docx is specified on the command line, pandoc will look
547 for a file `reference.docx` in the user data directory (see
548 `--data-dir`). If this is not found either, sensible defaults will be
549 used. The following styles are used by pandoc: [paragraph]
550 Normal, Compact, Title, Subtitle, Authors, Date, Abstract, Heading 1,
551 Heading 2, Heading 3, Heading 4, Heading 5, Block Quote, Definition Term,
552 Definition, Body Text, Table Caption, Image Caption; [character] Default
553 Paragraph Font, Body Text Char, Verbatim Char, Footnote Ref,
556`--epub-stylesheet=`*FILE*
557: Use the specified CSS file to style the EPUB. If no stylesheet
558 is specified, pandoc will look for a file `epub.css` in the
559 user data directory (see `--data-dir`). If it is not
560 found there, sensible defaults will be used.
562`--epub-cover-image=`*FILE*
563: Use the specified image as the EPUB cover. It is recommended
564 that the image be less than 1000px in width and height. Note that
565 in a markdown source document you can also specify `cover-image`
566 in a YAML metadata block (see [EPUB Metadata], below).
568`--epub-metadata=`*FILE*
569: Look in the specified XML file for metadata for the EPUB.
570 The file should contain a series of Dublin Core elements,
571 as documented at <http://dublincore.org/documents/dces/>.
574 <dc:rights>Creative Commons</dc:rights>
575 <dc:language>es-AR</dc:language>
577 By default, pandoc will include the following metadata elements:
578 `<dc:title>` (from the document title), `<dc:creator>` (from the
579 document authors), `<dc:date>` (from the document date, which should
580 be in [ISO 8601 format]), `<dc:language>` (from the `lang`
581 variable, or, if is not set, the locale), and `<dc:identifier
582 id="BookId">` (a randomly generated UUID). Any of these may be
583 overridden by elements in the metadata file.
585 Note: if the source document is markdown, a YAML metadata block
586 in the document can be used instead. See below under
589`--epub-embed-font=`*FILE*
590: Embed the specified font in the EPUB. This option can be repeated
591 to embed multiple fonts. To use embedded fonts, you
592 will need to add declarations like the following to your CSS (see
593 `--epub-stylesheet`):
596 font-family: DejaVuSans;
599 src:url("DejaVuSans-Regular.ttf");
602 font-family: DejaVuSans;
605 src:url("DejaVuSans-Bold.ttf");
608 font-family: DejaVuSans;
611 src:url("DejaVuSans-Oblique.ttf");
614 font-family: DejaVuSans;
617 src:url("DejaVuSans-BoldOblique.ttf");
619 body { font-family: "DejaVuSans"; }
621`--epub-chapter-level=`*NUMBER*
622: Specify the header level at which to split the EPUB into separate
623 "chapter" files. The default is to split into chapters at level 1
624 headers. This option only affects the internal composition of the
625 EPUB, not the way chapters and sections are displayed to users. Some
626 readers may be slow if the chapter files are too large, so for large
627 documents with few level 1 headers, one might want to use a chapter
630`--latex-engine=`*pdflatex|lualatex|xelatex*
631: Use the specified LaTeX engine when producing PDF output.
632 The default is `pdflatex`. If the engine is not in your PATH,
633 the full path of the engine may be specified here.
638`--bibliography=`*FILE*
639: Set the `bibliography` field in the document's metadata to *FILE*,
640 overriding any value set in the metadata, and process citations
641 using `pandoc-citeproc`. (This is equivalent to
642 `--metadata bibliography=FILE --filter pandoc-citeproc`.)
645: Set the `csl` field in the document's metadata to *FILE*,
646 overriding any value set in the metadata. (This is equivalent to
647 `--metadata csl=FILE`.)
649`--citation-abbreviations=`*FILE*
650: Set the `citation-abbreviations` field in the document's metadata to
651 *FILE*, overriding any value set in the metadata. (This is equivalent to
652 `--metadata citation-abbreviations=FILE`.)
655: Use natbib for citations in LaTeX output. This option is not for use
656 with the `pandoc-citeproc` filter or with PDF output. It is intended for
657 use in producing a LaTeX file that can be processed with pdflatex and
661: Use biblatex for citations in LaTeX output. This option is not for use
662 with the `pandoc-citeproc` filter or with PDF output. It is intended for
663 use in producing a LaTeX file that can be processed with pdflatex and
666Math rendering in HTML
667----------------------
669`-m` [*URL*], `--latexmathml`[=*URL*]
670: Use the [LaTeXMathML] script to display embedded TeX math in HTML output.
671 To insert a link to a local copy of the `LaTeXMathML.js` script,
672 provide a *URL*. If no *URL* is provided, the contents of the
673 script will be inserted directly into the HTML header, preserving
674 portability at the price of efficiency. If you plan to use math on
675 several pages, it is much better to link to a copy of the script,
679: Convert TeX math to MathML (in `docbook` as well as `html` and `html5`).
680 In standalone `html` output, a small javascript (or a link to such a
681 script if a *URL* is supplied) will be inserted that allows the MathML to
682 be viewed on some browsers.
685: Use [jsMath] to display embedded TeX math in HTML output.
686 The *URL* should point to the jsMath load script (e.g.
687 `jsMath/easy/load.js`); if provided, it will be linked to in
688 the header of standalone HTML documents. If a *URL* is not provided,
689 no link to the jsMath load script will be inserted; it is then
690 up to the author to provide such a link in the HTML template.
693: Use [MathJax] to display embedded TeX math in HTML output.
694 The *URL* should point to the `MathJax.js` load script.
695 If a *URL* is not provided, a link to the MathJax CDN will
699: Enclose TeX math in `<eq>` tags in HTML output. These can then
700 be processed by [gladTeX] to produce links to images of the typeset
704: Render TeX math using the [mimeTeX] CGI script. If *URL* is not
705 specified, it is assumed that the script is at `/cgi-bin/mimetex.cgi`.
708: Render TeX formulas using an external script that converts TeX
709 formulas to images. The formula will be concatenated with the URL
710 provided. If *URL* is not specified, the Google Chart API will be used.
712Options for wrapper scripts
713---------------------------
716: Print information about command-line arguments to *stdout*, then exit.
717 This option is intended primarily for use in wrapper scripts.
718 The first line of output contains the name of the output file specified
719 with the `-o` option, or `-` (for *stdout*) if no output file was
720 specified. The remaining lines contain the command-line arguments,
721 one per line, in the order they appear. These do not include regular
722 Pandoc options and their arguments, but do include any options appearing
723 after a `--` separator at the end of the line.
726: Ignore command-line arguments (for use in wrapper scripts).
727 Regular Pandoc options are not ignored. Thus, for example,
729 pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1
733 pandoc -o foo.html -s
735[LaTeXMathML]: http://math.etsu.edu/LaTeXMathML/
736[jsMath]: http://www.math.union.edu/~dpvc/jsmath/
737[MathJax]: http://www.mathjax.org/
738[gladTeX]: http://ans.hsh.no/home/mgg/gladtex/
739[mimeTeX]: http://www.forkosh.com/mimetex.html
740[CSL]: http://CitationStyles.org
745When the `-s/--standalone` option is used, pandoc uses a template to
746add header and footer material that is needed for a self-standing
747document. To see the default template that is used, just type
751where `FORMAT` is the name of the output format. A custom template
752can be specified using the `--template` option. You can also override
753the system default templates for a given output format `FORMAT`
754by putting a file `templates/default.FORMAT` in the user data
755directory (see `--data-dir`, above). *Exceptions:* For `odt` output,
756customize the `default.opendocument` template. For `pdf` output,
757customize the `default.latex` template.
759Templates may contain *variables*. Variable names are sequences of
760alphanumerics, `-`, and `_`, starting with a letter. A variable name
761surrounded by `$` signs will be replaced by its value. For example,
762the string `$title$` in
764 <title>$title$</title>
766will be replaced by the document title.
768To write a literal `$` in a template, use `$$`.
770Some variables are set automatically by pandoc. These vary somewhat
771depending on the output format, but include metadata fields (such
772as `title`, `author`, and `date`) as well as the following:
775: contents specified by `-H/--include-in-header` (may have multiple
778: non-null value if `--toc/--table-of-contents` was specified
780: contents specified by `-B/--include-before-body` (may have
783: contents specified by `-A/--include-after-body` (may have
788: language code for HTML or LaTeX documents
790: base URL for Slidy documents (defaults to
791 `http://www.w3.org/Talks/Tools/Slidy2`)
793: base URL for Slideous documents (defaults to `slideous`)
795: base URL for S5 documents (defaults to `s5/default`)
797: base URL for reveal.js documents (defaults to `reveal.js`)
799: reveal.js or LaTeX beamer theme
801: reveal.js transition
803: font size (10pt, 11pt, 12pt) for LaTeX documents
805: document class for LaTeX documents
807: option for LaTeX documentclass, e.g. `oneside`; may be repeated
810: options for LaTeX `geometry` class, e.g. `margin=1in`;
811 may be repeated for multiple options
813: adjusts line spacing (requires the `setspace` package)
815: font package to use for LaTeX documents (with pdflatex):
816 TeXLive has `bookman` (Bookman), `utopia` or `fourier` (Utopia),
817 `fouriernc` (New Century Schoolbook), `times` or `txfonts` (Times),
818 `mathpazo` or `pxfonts` or `mathpple` (Palatino),
819 `libertine` (Linux Libertine), `arev` (Arev Sans),
820 and the default `lmodern`, among others.
821`mainfont`, `sansfont`, `monofont`, `mathfont`
822: fonts for LaTeX documents (works only with xelatex
825: colortheme for LaTeX beamer documents
827: fonttheme for LaTeX beamer documents
829: color for internal links in LaTeX documents (`red`, `green`,
830 `magenta`, `cyan`, `blue`, `black`)
832: color for external links in LaTeX documents
834: color for citation links in LaTeX documents
836: causes links to be printed as footnotes in LaTeX documents
838: include table of contents in LaTeX documents
840: level of section to include in table of contents in LaTeX documents
842: include list of figures in LaTeX documents
844: include list of tables in LaTeX documents
846: bibliography style in LaTeX, when used with `--natbib`
848: bibliography files to use in LaTeX, with `--natbib` or `--biblatex`
850: section number in man pages
856Variables may be set at the command line using the `-V/--variable`
857option. Variables set in this way override metadata fields with
860Templates may contain conditionals. The syntax is as follows:
868This will include `X` in the template if `variable` has a non-null
869value; otherwise it will include `Y`. `X` and `Y` are placeholders for
870any valid template text, and may include interpolated variables or other
871conditionals. The `$else$` section may be omitted.
873When variables can have multiple values (for example, `author` in
874a multi-author document), you can use the `$for$` keyword:
877 <meta name="author" content="$author$" />
880You can optionally specify a separator to be used between
883 $for(author)$$author$$sep$, $endfor$
885A dot can be used to select a field of a variable that takes
886an object as its value. So, for example:
888 $author.name$ ($author.affiliation$)
890If you use custom templates, you may need to revise them as pandoc
891changes. We recommend tracking the changes in the default templates,
892and modifying your custom templates accordingly. An easy way to do this
893is to fork the pandoc-templates repository
894(<http://github.com/jgm/pandoc-templates>) and merge in changes after each
900Pandoc understands an extended and slightly revised version of
901John Gruber's [markdown] syntax. This document explains the syntax,
902noting differences from standard markdown. Except where noted, these
903differences can be suppressed by using the `markdown_strict` format instead
904of `markdown`. An extensions can be enabled by adding `+EXTENSION`
905to the format name and disabled by adding `-EXTENSION`. For example,
906`markdown_strict+footnotes` is strict markdown with footnotes
907enabled, while `markdown-footnotes-pipe_tables` is pandoc's
908markdown without footnotes or pipe tables.
913Markdown is designed to be easy to write, and, even more importantly,
916> A Markdown-formatted document should be publishable as-is, as plain
917> text, without looking like it's been marked up with tags or formatting
919> -- [John Gruber](http://daringfireball.net/projects/markdown/syntax#philosophy)
921This principle has guided pandoc's decisions in finding syntax for
922tables, footnotes, and other extensions.
924There is, however, one respect in which pandoc's aims are different
925from the original aims of markdown. Whereas markdown was originally
926designed with HTML generation in mind, pandoc is designed for multiple
927output formats. Thus, while pandoc allows the embedding of raw HTML,
928it discourages it, and provides other, non-HTMLish ways of representing
929important document elements like definition lists, tables, mathematics, and
935A paragraph is one or more lines of text followed by one or more blank line.
936Newlines are treated as spaces, so you can reflow your paragraphs as you like.
937If you need a hard line break, put two or more spaces at the end of a line.
939**Extension: `escaped_line_breaks`**
941A backslash followed by a newline is also a hard line break.
942Note: in multiline and grid table cells, this is the only way
943to create a hard line break, since trailing spaces in the cells
949There are two kinds of headers, Setext and atx.
951### Setext-style headers ###
953A setext-style header is a line of text "underlined" with a row of `=` signs
954(for a level one header) or `-` signs (for a level two header):
962The header text can contain inline formatting, such as emphasis (see
963[Inline formatting](#inline-formatting), below).
966### Atx-style headers ###
968An Atx-style header consists of one to six `#` signs and a line of
969text, optionally followed by any number of `#` signs. The number of
970`#` signs at the beginning of the line is the header level:
972 ## A level-two header
974 ### A level-three header ###
976As with setext-style headers, the header text can contain formatting:
978 # A level-one header with a [link](/url) and *emphasis*
980**Extension: `blank_before_header`**
982Standard markdown syntax does not require a blank line before a header.
983Pandoc does require this (except, of course, at the beginning of the
984document). The reason for the requirement is that it is all too easy for a
985`#` to end up at the beginning of a line by accident (perhaps through line
986wrapping). Consider, for example:
988 I like several of their flavors of ice cream:
989 #22, for example, and #5.
992### Header identifiers in HTML, LaTeX, and ConTeXt ###
994**Extension: `header_attributes`**
996Headers can be assigned attributes using this syntax at the end
997of the line containing the header text:
999 {#identifier .class .class key=value key=value}
1001Thus, for example, the following headers will all be assigned the identifier
1006 ## My header ## {#foo}
1008 My other header {#foo}
1011(This syntax is compatible with [PHP Markdown Extra].)
1013Note that although this syntax allows assignment of classes and key/value
1014attributes, writers generally don't use all of this information. Identifiers,
1015classes, and key/value attributes are used in HTML and HTML-based formats such
1016as EPUB and slidy. Identifiers are used for labels and link anchors in the
1017LaTeX, ConTeXt, Textile, and AsciiDoc writers.
1019Headers with the class `unnumbered` will not be numbered, even if
1020`--number-sections` is specified. A single hyphen (`-`) in an attribute
1021context is equivalent to `.unnumbered`, and preferable in non-English
1028 # My header {.unnumbered}
1030**Extension: `auto_identifiers`**
1032A header without an explicitly specified identifier will be
1033automatically assigned a unique identifier based on the header text.
1034To derive the identifier from the header text,
1036 - Remove all formatting, links, etc.
1037 - Remove all footnotes.
1038 - Remove all punctuation, except underscores, hyphens, and periods.
1039 - Replace all spaces and newlines with hyphens.
1040 - Convert all alphabetic characters to lowercase.
1041 - Remove everything up to the first letter (identifiers may
1042 not begin with a number or punctuation mark).
1043 - If nothing is left after this, use the identifier `section`.
1048 ------------------------------- ----------------------------
1049 Header identifiers in HTML `header-identifiers-in-html`
1050 *Dogs*?--in *my* house? `dogs--in-my-house`
1051 [HTML], [S5], or [RTF]? `html-s5-or-rtf`
1052 3. Applications `applications`
1055These rules should, in most cases, allow one to determine the identifier
1056from the header text. The exception is when several headers have the
1057same text; in this case, the first will get an identifier as described
1058above; the second will get the same identifier with `-1` appended; the
1059third with `-2`; and so on.
1061These identifiers are used to provide link targets in the table of
1062contents generated by the `--toc|--table-of-contents` option. They
1063also make it easy to provide links from one section of a document to
1064another. A link to this section, for example, might look like this:
1067 [header identifiers](#header-identifiers-in-html-latex-and-context).
1069Note, however, that this method of providing links to sections works
1070only in HTML, LaTeX, and ConTeXt formats.
1072If the `--section-divs` option is specified, then each section will
1073be wrapped in a `div` (or a `section`, if `--html5` was specified),
1074and the identifier will be attached to the enclosing `<div>`
1075(or `<section>`) tag rather than the header itself. This allows entire
1076sections to be manipulated using javascript or treated differently in
1079**Extension: `implicit_header_references`**
1081Pandoc behaves as if reference links have been defined for each header.
1084 [header identifiers](#header-identifiers-in-html)
1088 [header identifiers]
1092 [header identifiers][]
1096 [the section on header identifiers][header identifiers]
1098If there are multiple headers with identical text, the corresponding
1099reference will link to the first one only, and you will need to use explicit
1100links to link to the others, as described above.
1102Unlike regular reference links, these references are case-sensitive.
1104Note: if you have defined an explicit identifier for a header,
1105then implicit references to it will not work.
1110Markdown uses email conventions for quoting blocks of text.
1111A block quotation is one or more paragraphs or other block elements
1112(such as lists or headers), with each line preceded by a `>` character
1113and a space. (The `>` need not start at the left margin, but it should
1114not be indented more than three spaces.)
1116 > This is a block quote. This
1117 > paragraph has two lines.
1119 > 1. This is a list inside a block quote.
1122A "lazy" form, which requires the `>` character only on the first
1123line of each block, is also allowed:
1125 > This is a block quote. This
1126 paragraph has two lines.
1128 > 1. This is a list inside a block quote.
1131Among the block elements that can be contained in a block quote are
1132other block quotes. That is, block quotes can be nested:
1134 > This is a block quote.
1136 > > A block quote within a block quote.
1138**Extension: `blank_before_blockquote`**
1140Standard markdown syntax does not require a blank line before a block
1141quote. Pandoc does require this (except, of course, at the beginning of the
1142document). The reason for the requirement is that it is all too easy for a
1143`>` to end up at the beginning of a line by accident (perhaps through line
1144wrapping). So, unless the `markdown_strict` format is used, the following does
1145not produce a nested block quote in pandoc:
1147 > This is a block quote.
1151Verbatim (code) blocks
1152----------------------
1154### Indented code blocks ###
1156A block of text indented four spaces (or one tab) is treated as verbatim
1157text: that is, special characters do not trigger special formatting,
1158and all spaces and line breaks are preserved. For example,
1161 moveShip(5 * gravity, DOWN);
1164The initial (four space or one tab) indentation is not considered part
1165of the verbatim text, and is removed in the output.
1167Note: blank lines in the verbatim text need not begin with four spaces.
1170### Fenced code blocks ###
1172**Extension: `fenced_code_blocks`**
1174In addition to standard indented code blocks, Pandoc supports
1175*fenced* code blocks. These begin with a row of three or more
1176tildes (`~`) or backticks (`` ` ``) and end with a row of tildes or
1177backticks that must be at least as long as the starting row. Everything
1178between these lines is treated as code. No indentation is necessary:
1182 moveShip(5 * gravity, DOWN);
1186Like regular code blocks, fenced code blocks must be separated
1187from surrounding text by blank lines.
1189If the code itself contains a row of tildes or backticks, just use a longer
1190row of tildes or backticks at the start and end:
1194 code including tildes
1198**Extension: `fenced_code_attributes`**
1200Optionally, you may attach attributes to the code block using
1203 ~~~~ {#mycode .haskell .numberLines startFrom="100"}
1205 qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
1206 qsort (filter (>= x) xs)
1207 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1209Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and
1210`startFrom` is an attribute with value `100`. Some output formats can use this
1211information to do syntax highlighting. Currently, the only output formats
1212that uses this information are HTML and LaTeX. If highlighting is supported
1213for your output format and language, then the code block above will appear
1214highlighted, with numbered lines. (To see which languages are supported, do
1215`pandoc --version`.) Otherwise, the code block above will appear as follows:
1217 <pre id="mycode" class="haskell numberLines" startFrom="100">
1223A shortcut form can also be used for specifying the language of
1230This is equivalent to:
1236If the `fenced_code_attributes` extension is disabled, but
1237input contains class attribute(s) for the codeblock, the first
1238class attribute will be printed after the opening fence as a bare
1241To prevent all highlighting, use the `--no-highlight` flag.
1242To set the highlighting style, use `--highlight-style`.
1247**Extension: `line_blocks`**
1249A line block is a sequence of lines beginning with a vertical bar (`|`)
1250followed by a space. The division into lines will be preserved in
1251the output, as will any leading spaces; otherwise, the lines will
1252be formatted as markdown. This is useful for verse and addresses:
1254 | The limerick packs laughs anatomical
1255 | In space that is quite economical.
1256 | But the good ones I've seen
1257 | So seldom are clean
1258 | And the clean ones so seldom are comical
1261 | Berkeley, CA 94718
1263The lines can be hard-wrapped if needed, but the continuation
1264line must begin with a space.
1266 | The Right Honorable Most Venerable and Righteous Samuel L.
1269 | Berkeley, CA 94718
1271This syntax is borrowed from [reStructuredText].
1278A bullet list is a list of bulleted list items. A bulleted list
1279item begins with a bullet (`*`, `+`, or `-`). Here is a simple
1286This will produce a "compact" list. If you want a "loose" list, in which
1287each item is formatted as a paragraph, put spaces between the items:
1295The bullets need not be flush with the left margin; they may be
1296indented one, two, or three spaces. The bullet must be followed
1299List items look best if subsequent lines are flush with the first
1300line (after the bullet):
1306But markdown also allows a "lazy" format:
1312### The four-space rule ###
1314A list item may contain multiple paragraphs and other block-level
1315content. However, subsequent paragraphs must be preceded by a blank line
1316and indented four spaces or a tab. The list will look better if the first
1317paragraph is aligned with the rest:
1323 * Second paragraph. With a code block, which must be indented
1328List items may include other lists. In this case the preceding blank
1329line is optional. The nested list must be indented four spaces or
1342As noted above, markdown allows you to write list items "lazily," instead of
1343indenting continuation lines. However, if there are multiple paragraphs or
1344other blocks in a list item, the first line of each must be indented.
1346 + A lazy, lazy, list
1349 + Another one; this looks
1352 Second paragraph of second
1355**Note:** Although the four-space rule for continuation paragraphs
1356comes from the official [markdown syntax guide], the reference implementation,
1357`Markdown.pl`, does not follow it. So pandoc will give different results than
1358`Markdown.pl` when authors have indented continuation paragraphs fewer than
1361The [markdown syntax guide] is not explicit whether the four-space
1362rule applies to *all* block-level content in a list item; it only
1363mentions paragraphs and code blocks. But it implies that the rule
1364applies to all block-level content (including nested lists), and
1365pandoc interprets it that way.
1367 [markdown syntax guide]:
1368 http://daringfireball.net/projects/markdown/syntax#list
1370### Ordered lists ###
1372Ordered lists work just like bulleted lists, except that the items
1373begin with enumerators rather than bullets.
1375In standard markdown, enumerators are decimal numbers followed
1376by a period and a space. The numbers themselves are ignored, so
1377there is no difference between this list:
1389**Extension: `fancy_lists`**
1391Unlike standard markdown, Pandoc allows ordered list items to be marked
1392with uppercase and lowercase letters and roman numerals, in addition to
1393arabic numerals. List markers may be enclosed in parentheses or followed by a
1394single right-parentheses or period. They must be separated from the
1395text that follows by at least one space, and, if the list marker is a
1396capital letter with a period, by at least two spaces.[^2]
1398[^2]: The point of this rule is to ensure that normal paragraphs
1399 starting with people's initials, like
1401 B. Russell was an English philosopher.
1403 do not get treated as list items.
1405 This rule will not prevent
1409 from being interpreted as a list item. In this case, a backslash
1414The `fancy_lists` extension also allows '`#`' to be used as an
1415ordered list marker in place of a numeral:
1420**Extension: `startnum`**
1422Pandoc also pays attention to the type of list marker used, and to the
1423starting number, and both of these are preserved where possible in the
1424output format. Thus, the following yields a list with numbers followed
1425by a single parenthesis, starting with 9, and a sublist with lowercase
1435Pandoc will start a new list each time a different type of list
1436marker is used. So, the following will create three lists:
1443If default list markers are desired, use `#.`:
1450### Definition lists ###
1452**Extension: `definition_lists`**
1454Pandoc supports definition lists, using the syntax of
1455[PHP Markdown Extra] with some extensions.[^3]
1461 Term 2 with *inline markup*
1465 { some code, part of Definition 2 }
1467 Third paragraph of definition 2.
1469Each term must fit on one line, which may optionally be followed by
1470a blank line, and must be followed by one or more definitions.
1471A definition begins with a colon or tilde, which may be indented one
1474A term may have multiple definitions, and each definition may consist of one or
1475more block elements (paragraph, code block, list, etc.), each indented four
1476spaces or one tab stop. The body of the definition (including the first line,
1477aside from the colon or tilde) should be indented four spaces. However,
1478as with other markdown lists, you can "lazily" omit indentation except
1479at the beginning of a paragraph or other block element:
1484 with lazy continuation.
1486 Second paragraph of the definition.
1488If you leave space before the definition (as in the example above),
1489the text of the definition will be treated as a paragraph. In some
1490output formats, this will mean greater spacing between term/definition
1491pairs. For a more compact definition list, omit the space before the
1501Note that space between items in a definition list is required.
1502(A variant that loosens this requirement, but disallows "lazy"
1503hard wrapping, can be activated with `compact_definition_lists`: see
1504[Non-pandoc extensions](#non-pandoc-extensions), below.)
1506[^3]: I have been influenced by the suggestions of [David Wheeler](http://www.justatheory.com/computers/markup/modest-markdown-proposal.html).
1508[PHP Markdown Extra]: http://www.michelf.com/projects/php-markdown/extra/
1511### Numbered example lists ###
1513**Extension: `example_lists`**
1515The special list marker `@` can be used for sequentially numbered
1516examples. The first list item with a `@` marker will be numbered '1',
1517the next '2', and so on, throughout the document. The numbered examples
1518need not occur in a single list; each new list using `@` will take up
1519where the last stopped. So, for example:
1521 (@) My first example will be numbered (1).
1522 (@) My second example will be numbered (2).
1524 Explanation of examples.
1526 (@) My third example will be numbered (3).
1528Numbered examples can be labeled and referred to elsewhere in the
1531 (@good) This is a good example.
1533 As (@good) illustrates, ...
1535The label can be any string of alphanumeric characters, underscores,
1539### Compact and loose lists ###
1541Pandoc behaves differently from `Markdown.pl` on some "edge
1542cases" involving lists. Consider this source:
1552Pandoc transforms this into a "compact list" (with no `<p>` tags around
1553"First", "Second", or "Third"), while markdown puts `<p>` tags around
1554"Second" and "Third" (but not "First"), because of the blank space
1555around "Third". Pandoc follows a simple rule: if the text is followed by
1556a blank line, it is treated as a paragraph. Since "Second" is followed
1557by a list, and not a blank line, it isn't treated as a paragraph. The
1558fact that the list is followed by a blank line is irrelevant. (Note:
1559Pandoc works this way even when the `markdown_strict` format is specified. This
1560behavior is consistent with the official markdown syntax description,
1561even though it is different from that of `Markdown.pl`.)
1564### Ending a list ###
1566What if you want to put an indented code block after a list?
1573Trouble! Here pandoc (like other markdown implementations) will treat
1574`{ my code block }` as the second paragraph of item two, and not as
1577To "cut off" the list after item two, you can insert some non-indented
1578content, like an HTML comment, which won't produce visible output in
1584 <!-- end of list -->
1588You can use the same trick if you want two consecutive lists instead
1604A line containing a row of three or more `*`, `-`, or `_` characters
1605(optionally separated by spaces) produces a horizontal rule:
1615Four kinds of tables may be used. The first three kinds presuppose the use of
1616a fixed-width font, such as Courier. The fourth kind can be used with
1617proportionally spaced fonts, as it does not require lining up columns.
1621**Extension: `simple_tables`, `table_captions`**
1623Simple tables look like this:
1625 Right Left Center Default
1626 ------- ------ ---------- -------
1631 Table: Demonstration of simple table syntax.
1633The headers and table rows must each fit on one line. Column
1634alignments are determined by the position of the header text relative
1635to the dashed line below it:[^4]
1637 - If the dashed line is flush with the header text on the right side
1638 but extends beyond it on the left, the column is right-aligned.
1639 - If the dashed line is flush with the header text on the left side
1640 but extends beyond it on the right, the column is left-aligned.
1641 - If the dashed line extends beyond the header text on both sides,
1642 the column is centered.
1643 - If the dashed line is flush with the header text on both sides,
1644 the default alignment is used (in most cases, this will be left).
1646[^4]: This scheme is due to Michel Fortin, who proposed it on the
1647 [Markdown discussion list](http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html).
1649The table must end with a blank line, or a line of dashes followed by
1650a blank line. A caption may optionally be provided (as illustrated in
1651the example above). A caption is a paragraph beginning with the string
1652`Table:` (or just `:`), which will be stripped off. It may appear either
1653before or after the table.
1655The column headers may be omitted, provided a dashed line is used
1656to end the table. For example:
1658 ------- ------ ---------- -------
1662 ------- ------ ---------- -------
1664When headers are omitted, column alignments are determined on the basis
1665of the first line of the table body. So, in the tables above, the columns
1666would be right, left, center, and right aligned, respectively.
1670**Extension: `multiline_tables`, `table_captions`**
1672Multiline tables allow headers and table rows to span multiple lines
1673of text (but cells that span multiple columns or rows of the table are
1674not supported). Here is an example:
1676 -------------------------------------------------------------
1677 Centered Default Right Left
1678 Header Aligned Aligned Aligned
1679 ----------- ------- --------------- -------------------------
1680 First row 12.0 Example of a row that
1681 spans multiple lines.
1683 Second row 5.0 Here's another one. Note
1684 the blank line between
1686 -------------------------------------------------------------
1688 Table: Here's the caption. It, too, may span
1691These work like simple tables, but with the following differences:
1693 - They must begin with a row of dashes, before the header text
1694 (unless the headers are omitted).
1695 - They must end with a row of dashes, then a blank line.
1696 - The rows must be separated by blank lines.
1698In multiline tables, the table parser pays attention to the widths of
1699the columns, and the writers try to reproduce these relative widths in
1700the output. So, if you find that one of the columns is too narrow in the
1701output, try widening it in the markdown source.
1703Headers may be omitted in multiline tables as well as simple tables:
1705 ----------- ------- --------------- -------------------------
1706 First row 12.0 Example of a row that
1707 spans multiple lines.
1709 Second row 5.0 Here's another one. Note
1710 the blank line between
1712 ----------- ------- --------------- -------------------------
1714 : Here's a multiline table without headers.
1716It is possible for a multiline table to have just one row, but the row
1717should be followed by a blank line (and then the row of dashes that ends
1718the table), or the table may be interpreted as a simple table.
1722**Extension: `grid_tables`, `table_captions`**
1724Grid tables look like this:
1726 : Sample grid table.
1728 +---------------+---------------+--------------------+
1729 | Fruit | Price | Advantages |
1730 +===============+===============+====================+
1731 | Bananas | $1.34 | - built-in wrapper |
1732 | | | - bright color |
1733 +---------------+---------------+--------------------+
1734 | Oranges | $2.10 | - cures scurvy |
1736 +---------------+---------------+--------------------+
1738The row of `=`s separates the header from the table body, and can be
1739omitted for a headerless table. The cells of grid tables may contain
1740arbitrary block elements (multiple paragraphs, code blocks, lists,
1741etc.). Alignments are not supported, nor are cells that span multiple
1742columns or rows. Grid tables can be created easily using [Emacs table mode].
1744 [Emacs table mode]: http://table.sourceforge.net/
1748**Extension: `pipe_tables`, `table_captions`**
1750Pipe tables look like this:
1752 | Right | Left | Default | Center |
1753 |------:|:-----|---------|:------:|
1754 | 12 | 12 | 12 | 12 |
1755 | 123 | 123 | 123 | 123 |
1758 : Demonstration of simple table syntax.
1760The syntax is [the same as in PHP markdown extra]. The beginning and
1761ending pipe characters are optional, but pipes are required between all
1762columns. The colons indicate column alignment as shown. The header
1763can be omitted, but the horizontal line must still be included, as
1764it defines column alignments.
1766Since the pipes indicate column boundaries, columns need not be vertically
1767aligned, as they are in the above example. So, this is a perfectly
1768legal (though ugly) pipe table:
1776The cells of pipe tables cannot contain block elements like paragraphs
1777and lists, and cannot span multiple lines. Note also that in LaTeX/PDF
1778output, the cells produced by pipe tables will not wrap, since there
1779is no information available about relative widths. If you want content
1780to wrap within cells, use multiline or grid tables.
1782 [the same as in PHP markdown extra]:
1783 http://michelf.ca/projects/php-markdown/extra/#table
1785Note: Pandoc also recognizes pipe tables of the following
1786form, as can produced by Emacs' orgtbl-mode:
1793The difference is that `+` is used instead of `|`. Other orgtbl features
1794are not supported. In particular, to get non-default column alignment,
1795you'll need to add colons as above.
1800**Extension: `pandoc_title_block`**
1802If the file begins with a title block
1805 % author(s) (separated by semicolons)
1808it will be parsed as bibliographic information, not regular text. (It
1809will be used, for example, in the title of standalone LaTeX or HTML
1810output.) The block may contain just a title, a title and an author,
1811or all three elements. If you want to include an author but no
1812title, or a title and a date but no author, you need a blank line:
1821The title may occupy multiple lines, but continuation lines must
1822begin with leading space, thus:
1827If a document has multiple authors, the authors may be put on
1828separate lines with leading space, or separated by semicolons, or
1829both. So, all of the following are equivalent:
1834 % Author One; Author Two
1839The date must fit on one line.
1841All three metadata fields may contain standard inline formatting
1842(italics, links, footnotes, etc.).
1844Title blocks will always be parsed, but they will affect the output only
1845when the `--standalone` (`-s`) option is chosen. In HTML output, titles
1846will appear twice: once in the document head -- this is the title that
1847will appear at the top of the window in a browser -- and once at the
1848beginning of the document body. The title in the document head can have
1849an optional prefix attached (`--title-prefix` or `-T` option). The title
1850in the body appears as an H1 element with class "title", so it can be
1851suppressed or reformatted with CSS. If a title prefix is specified with
1852`-T` and no title block appears in the document, the title prefix will
1853be used by itself as the HTML title.
1855The man page writer extracts a title, man page section number, and
1856other header and footer information from the title line. The title
1857is assumed to be the first word on the title line, which may optionally
1858end with a (single-digit) section number in parentheses. (There should
1859be no space between the title and the parentheses.) Anything after
1860this is assumed to be additional footer and header text. A single pipe
1861character (`|`) should be used to separate the footer text from the header
1866will yield a man page with the title `PANDOC` and section 1.
1868 % PANDOC(1) Pandoc User Manuals
1870will also have "Pandoc User Manuals" in the footer.
1872 % PANDOC(1) Pandoc User Manuals | Version 4.0
1874will also have "Version 4.0" in the header.
1879**Extension: `yaml_metadata_block`**
1881A YAML metadata block is a valid YAML object, delimited by a line of three
1882hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
1883(`...`) at the bottom. A YAML metadata block may occur anywhere in the
1884document, but if it is not at the beginning, it must be preceded by a blank
1885line. (Note that, because of the way pandoc concatenates input files when
1886several are provided, you may also keep the metadata in a separate YAML file
1887and pass it to pandoc as an argument, along with your markdown files:
1889 pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
1891Just be sure that the YAML file begins with `---` and ends with `---` or
1894Metadata will be taken from the fields of the YAML object and added to any
1895existing document metadata. Metadata can contain lists and objects (nested
1896arbitrarily), but all string scalars will be interpreted as markdown. Fields
1897with names ending in an underscore will be ignored by pandoc. (They may be
1898given a role by external processors.)
1900A document may contain multiple metadata blocks. The metadata fields will
1901be combined through a *left-biased union*: if two metadata blocks attempt
1902to set the same field, the value from the first block will be taken.
1904Note that YAML escaping rules must be followed. Thus, for example,
1905if a title contains a colon, it must be quoted. The pipe character
1906(`|`) can be used to begin an indented block that will be interpreted
1907literally, without need for escaping. This form is necessary
1908when the field contains blank lines:
1911 title: 'This is the title: it contains a colon'
1914 affiliation: University of Somewhere
1916 affiliation: University of Nowhere
1917 tags: [nothing, nothingness]
1919 This is the abstract.
1921 It consists of two paragraphs.
1924Template variables will be set automatically from the metadata. Thus, for
1925example, in writing HTML, the variable `abstract` will be set to the HTML
1926equivalent of the markdown in the `abstract` field:
1928 <p>This is the abstract.</p>
1929 <p>It consists of two paragraphs.</p>
1931Note: The `author` variable in the default templates expects a simple list or
1932string. To use the structured authors in the example, you would need a
1933custom template. For example:
1937 $author.name$$if(author.affiliation)$ ($author.affiliation$)$endif$
1947**Extension: `all_symbols_escapable`**
1949Except inside a code block or inline code, any punctuation or space
1950character preceded by a backslash will be treated literally, even if it
1951would normally indicate formatting. Thus, for example, if one writes
1961 <strong>hello</strong>
1963This rule is easier to remember than standard markdown's rule,
1964which allows only the following characters to be backslash-escaped:
1968(However, if the `markdown_strict` format is used, the standard markdown rule
1971A backslash-escaped space is parsed as a nonbreaking space. It will
1972appear in TeX output as `~` and in HTML and XML as `\ ` or
1975A backslash-escaped newline (i.e. a backslash occurring at the end of
1976a line) is parsed as a hard line break. It will appear in TeX output as
1977`\\` and in HTML as `<br />`. This is a nice alternative to
1978markdown's "invisible" way of indicating hard line breaks using
1979two trailing spaces on a line.
1981Backslash escapes do not work in verbatim contexts.
1988If the `--smart` option is specified, pandoc will produce typographically
1989correct output, converting straight quotes to curly quotes, `---` to
1990em-dashes, `--` to en-dashes, and `...` to ellipses. Nonbreaking spaces
1991are inserted after certain abbreviations, such as "Mr."
1993Note: if your LaTeX template uses the `csquotes` package, pandoc will
1994detect automatically this and use `\enquote{...}` for quoted text.
2001To *emphasize* some text, surround it with `*`s or `_`, like this:
2003 This text is _emphasized with underscores_, and this
2004 is *emphasized with asterisks*.
2006Double `*` or `_` produces **strong emphasis**:
2008 This is **strong emphasis** and __with underscores__.
2010A `*` or `_` character surrounded by spaces, or backslash-escaped,
2011will not trigger emphasis:
2013 This is * not emphasized *, and \*neither is this\*.
2015**Extension: `intraword_underscores`**
2017Because `_` is sometimes used inside words and identifiers,
2018pandoc does not interpret a `_` surrounded by alphanumeric
2019characters as an emphasis marker. If you want to emphasize
2020just part of a word, use `*`:
2022 feas*ible*, not feas*able*.
2027**Extension: `strikeout`**
2029To strikeout a section of text with a horizontal line, begin and end it
2030with `~~`. Thus, for example,
2032 This ~~is deleted text.~~
2035### Superscripts and subscripts ###
2037**Extension: `superscript`, `subscript`**
2039Superscripts may be written by surrounding the superscripted text by `^`
2040characters; subscripts may be written by surrounding the subscripted
2041text by `~` characters. Thus, for example,
2043 H~2~O is a liquid. 2^10^ is 1024.
2045If the superscripted or subscripted text contains spaces, these spaces
2046must be escaped with backslashes. (This is to prevent accidental
2047superscripting and subscripting through the ordinary use of `~` and `^`.)
2048Thus, if you want the letter P with 'a cat' in subscripts, use
2049`P~a\ cat~`, not `P~a cat~`.
2054To make a short span of text verbatim, put it inside backticks:
2056 What is the difference between `>>=` and `>>`?
2058If the verbatim text includes a backtick, use double backticks:
2060 Here is a literal backtick `` ` ``.
2062(The spaces after the opening backticks and before the closing
2063backticks will be ignored.)
2065The general rule is that a verbatim span starts with a string
2066of consecutive backticks (optionally followed by a space)
2067and ends with a string of the same number of backticks (optionally
2068preceded by a space).
2070Note that backslash-escapes (and other markdown constructs) do not
2071work in verbatim contexts:
2073 This is a backslash followed by an asterisk: `\*`.
2075**Extension: `inline_code_attributes`**
2077Attributes can be attached to verbatim text, just as with
2078[fenced code blocks](#fenced-code-blocks):
2084To write small caps, you can use an HTML span tag:
2086 <span style="font-variant:small-caps;">Small caps</span>
2088(The semicolon is optional and there may be space after the
2089colon.) This will work in all output formats that support small caps.
2094**Extension: `tex_math_dollars`**
2096Anything between two `$` characters will be treated as TeX math. The
2097opening `$` must have a character immediately to its right, while the
2098closing `$` must have a character immediately to its left. Thus,
2099`$20,000 and $30,000` won't parse as math. If for some reason
2100you need to enclose text in literal `$` characters, backslash-escape
2101them and they won't be treated as math delimiters.
2103TeX math will be printed in all output formats. How it is rendered
2104depends on the output format:
2106Markdown, LaTeX, Org-Mode, ConTeXt
2107 ~ It will appear verbatim between `$` characters.
2110 ~ It will be rendered using an interpreted text role `:math:`, as described
2111 [here](http://www.american.edu/econ/itex2mml/mathhack.rst).
2114 ~ It will be rendered as `latexmath:[...]`.
2117 ~ It will be rendered inside a `@math` command.
2120 ~ It will be rendered verbatim without `$`'s.
2123 ~ It will be rendered inside `<math>` tags.
2126 ~ It will be rendered inside `<span class="math">` tags.
2128RTF, OpenDocument, ODT
2129 ~ It will be rendered, if possible, using unicode characters,
2130 and will otherwise appear verbatim.
2133 ~ If the `--mathml` flag is used, it will be rendered using mathml
2134 in an `inlineequation` or `informalequation` tag. Otherwise it
2135 will be rendered, if possible, using unicode characters.
2138 ~ It will be rendered using OMML math markup.
2141 ~ If the `--webtex` option is used, formulas are rendered as images
2142 using Google Charts or other compatible web service, downloaded
2143 and embedded in the e-book. Otherwise, they will appear verbatim.
2145HTML, Slidy, DZSlides, S5, EPUB
2146 ~ The way math is rendered in HTML will depend on the
2147 command-line options selected:
2149 1. The default is to render TeX math as far as possible using unicode
2150 characters, as with RTF, DocBook, and OpenDocument output. Formulas
2151 are put inside a `span` with `class="math"`, so that they may be
2152 styled differently from the surrounding text if needed.
2154 2. If the `--latexmathml` option is used, TeX math will be displayed
2155 between `$` or `$$` characters and put in `<span>` tags with class `LaTeX`.
2156 The [LaTeXMathML] script will be used to render it as formulas.
2157 (This trick does not work in all browsers, but it works in Firefox.
2158 In browsers that do not support LaTeXMathML, TeX math will appear
2159 verbatim between `$` characters.)
2161 3. If the `--jsmath` option is used, TeX math will be put inside
2162 `<span>` tags (for inline math) or `<div>` tags (for display math)
2163 with class `math`. The [jsMath] script will be used to render
2166 4. If the `--mimetex` option is used, the [mimeTeX] CGI script will
2167 be called to generate images for each TeX formula. This should
2168 work in all browsers. The `--mimetex` option takes an optional URL
2169 as argument. If no URL is specified, it will be assumed that the
2170 mimeTeX CGI script is at `/cgi-bin/mimetex.cgi`.
2172 5. If the `--gladtex` option is used, TeX formulas will be enclosed
2173 in `<eq>` tags in the HTML output. The resulting `htex` file may then
2174 be processed by [gladTeX], which will produce image files for each
2175 formula and an `html` file with links to these images. So, the
2178 pandoc -s --gladtex myfile.txt -o myfile.htex
2179 gladtex -d myfile-images myfile.htex
2180 # produces myfile.html and images in myfile-images
2182 6. If the `--webtex` option is used, TeX formulas will be converted
2183 to `<img>` tags that link to an external script that converts
2184 formulas to images. The formula will be URL-encoded and concatenated
2185 with the URL provided. If no URL is specified, the Google Chart
2186 API will be used (`http://chart.apis.google.com/chart?cht=tx&chl=`).
2188 7. If the `--mathjax` option is used, TeX math will be displayed
2189 between `\(...\)` (for inline math) or `\[...\]` (for display
2190 math) and put in `<span>` tags with class `math`.
2191 The [MathJax] script will be used to render it as formulas.
2196**Extension: `raw_html`**
2198Markdown allows you to insert raw HTML (or DocBook) anywhere in a document
2199(except verbatim contexts, where `<`, `>`, and `&` are interpreted
2200literally). (Technically this is not an extension, since standard
2201markdown allows it, but it has been made an extension so that it can
2202be disabled if desired.)
2204The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
2205DZSlides, EPUB, Markdown, and Textile output, and suppressed in other
2208**Extension: `markdown_in_html_blocks`**
2210Standard markdown allows you to include HTML "blocks": blocks
2211of HTML between balanced tags that are separated from the surrounding text
2212with blank lines, and start and end at the left margin. Within
2213these blocks, everything is interpreted as HTML, not markdown;
2214so (for example), `*` does not signify emphasis.
2216Pandoc behaves this way when the `markdown_strict` format is used; but
2217by default, pandoc interprets material between HTML block tags as markdown.
2218Thus, for example, Pandoc will turn
2223 <td>[a link](http://google.com)</td>
2231 <td><em>one</em></td>
2232 <td><a href="http://google.com">a link</a></td>
2236whereas `Markdown.pl` will preserve it as is.
2238There is one exception to this rule: text between `<script>` and
2239`<style>` tags is not interpreted as markdown.
2241This departure from standard markdown should make it easier to mix
2242markdown with HTML block elements. For example, one can surround
2243a block of markdown text with `<div>` tags without preventing it
2244from being interpreted as markdown.
2249**Extension: `raw_tex`**
2251In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be
2252included in a document. Inline TeX commands will be preserved and passed
2253unchanged to the LaTeX and ConTeXt writers. Thus, for example, you can use
2254LaTeX to include BibTeX citations:
2256 This result was proved in \cite{jones.1967}.
2258Note that in LaTeX environments, like
2260 \begin{tabular}{|l|l|}\hline
2261 Age & Frequency \\ \hline
2264 36--45 & 22 \\ \hline
2267the material between the begin and end tags will be interpreted as raw
2268LaTeX, not as markdown.
2270Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
2276**Extension: `latex_macros`**
2278For output formats other than LaTeX, pandoc will parse LaTeX `\newcommand` and
2279`\renewcommand` definitions and apply the resulting macros to all LaTeX
2280math. So, for example, the following will work in all output formats,
2283 \newcommand{\tuple}[1]{\langle #1 \rangle}
2287In LaTeX output, the `\newcommand` definition will simply be passed
2288unchanged to the output.
2294Markdown allows links to be specified in several ways.
2296### Automatic links ###
2298If you enclose a URL or email address in pointy brackets, it
2302 <sam@green.eggs.ham>
2306An inline link consists of the link text in square brackets,
2307followed by the URL in parentheses. (Optionally, the URL can
2308be followed by a link title, in quotes.)
2310 This is an [inline link](/url), and here's [one with
2311 a title](http://fsf.org "click here for a good time!").
2313There can be no space between the bracketed part and the parenthesized part.
2314The link text can contain formatting (such as emphasis), but the title cannot.
2317### Reference links ###
2319An *explicit* reference link has two parts, the link itself and the link
2320definition, which may occur elsewhere in the document (either
2321before or after the link).
2323The link consists of link text in square brackets, followed by a label in
2324square brackets. (There can be space between the two.) The link definition
2325consists of the bracketed label, followed by a colon and a space, followed by
2326the URL, and optionally (after a space) a link title either in quotes or in
2329Here are some examples:
2331 [my label 1]: /foo/bar.html "My title, optional"
2333 [my label 3]: http://fsf.org (The free software foundation)
2334 [my label 4]: /bar#special 'A title in single quotes'
2336The URL may optionally be surrounded by angle brackets:
2338 [my label 5]: <http://foo.bar.baz>
2340The title may go on the next line:
2342 [my label 3]: http://fsf.org
2343 "The free software foundation"
2345Note that link labels are not case sensitive. So, this will work:
2347 Here is [my link][FOO]
2351In an *implicit* reference link, the second pair of brackets is
2352empty, or omitted entirely:
2354 See [my website][], or [my website].
2356 [my website]: http://foo.bar.baz
2358Note: In `Markdown.pl` and most other markdown implementations,
2359reference link definitions cannot occur in nested constructions
2360such as list items or block quotes. Pandoc lifts this arbitrary
2361seeming restriction. So the following is fine in pandoc, though
2362not in most other implementations:
2370To link to another section of the same document, use the automatically
2371generated identifier (see [Header identifiers in HTML, LaTeX, and
2372ConTeXt](#header-identifiers-in-html-latex-and-context), below).
2375 See the [Introduction](#introduction).
2379 See the [Introduction].
2381 [Introduction]: #introduction
2383Internal links are currently supported for HTML formats (including
2384HTML slide shows and EPUB), LaTeX, and ConTeXt.
2389A link immediately preceded by a `!` will be treated as an image.
2390The link text will be used as the image's alt text:
2392 
2396 [movie reel]: movie.gif
2398### Pictures with captions ###
2400**Extension: `implicit_figures`**
2402An image occurring by itself in a paragraph will be rendered as
2403a figure with a caption.[^5] (In LaTeX, a figure environment will be
2404used; in HTML, the image will be placed in a `div` with class
2405`figure`, together with a caption in a `p` with class `caption`.)
2406The image's alt text will be used as the caption.
2408 
2410[^5]: This feature is not yet implemented for RTF, OpenDocument, or
2411 ODT. In those formats, you'll just get an image in a paragraph by
2412 itself, with no caption.
2414If you just want a regular inline image, just make sure it is not
2415the only thing in the paragraph. One way to do this is to insert a
2416nonbreaking space after the image:
2418 \
2424**Extension: `footnotes`**
2426Pandoc's markdown allows footnotes, using the following syntax:
2428 Here is a footnote reference,[^1] and another.[^longnote]
2430 [^1]: Here is the footnote.
2432 [^longnote]: Here's one with multiple blocks.
2434 Subsequent paragraphs are indented to show that they
2435 belong to the previous footnote.
2439 The whole paragraph can be indented, or just the first
2440 line. In this way, multi-paragraph footnotes work like
2441 multi-paragraph list items.
2443 This paragraph won't be part of the note, because it
2446The identifiers in footnote references may not contain spaces, tabs,
2447or newlines. These identifiers are used only to correlate the
2448footnote reference with the note itself; in the output, footnotes
2449will be numbered sequentially.
2451The footnotes themselves need not be placed at the end of the
2452document. They may appear anywhere except inside other block elements
2453(lists, block quotes, tables, etc.).
2455**Extension: `inline_notes`**
2457Inline footnotes are also allowed (though, unlike regular notes,
2458they cannot contain multiple paragraphs). The syntax is as follows:
2460 Here is an inline note.^[Inlines notes are easier to write, since
2461 you don't have to pick an identifier and move down to type the
2464Inline and regular footnotes may be mixed freely.
2470**Extension: `citations`**
2472Using an external filter, `pandoc-citeproc`, pandoc can automatically generate
2473citations and a bibliography in a number of styles. Basic usage is
2475 pandoc --filter pandoc-citeproc myinput.txt
2477In order to use this feature, you will need to specify a bibliography file
2478using the `bibliography` metadata field in a YAML metadata section.
2479The bibliography may have any of these formats:
2481 Format File extension
2482 ------------ --------------
2494Note that `.bib` can generally be used with both BibTeX and BibLaTeX
2495files, but you can use `.bibtex` to force BibTeX.
2497Alternatively you can use a `references` field in the document's YAML
2498metadata. This should include an array of YAML-encoded references,
2504 title: One-click science marketing
2508 container-title: Nature Materials
2510 URL: 'http://dx.doi.org/10.1038/nmat3283'
2511 DOI: 10.1038/nmat3283
2513 publisher: Nature Publishing Group
2515 type: article-journal
2521(The program `mods2yaml`, which comes with `pandoc-citeproc`, can help produce
2522these from a MODS reference collection.)
2524By default, `pandoc-citeproc` will use a Chicago author-date format for
2525citations and references. To use another style, you will need to specify
2526a [CSL] 1.0 style file in the `csl` metadata field. A primer on creating and
2527modifying CSL styles can be found at
2528<http://citationstyles.org/downloads/primer.html>. A repository of CSL styles
2529can be found at <https://github.com/citation-style-language/styles>. See also
2530<http://zotero.org/styles> for easy browsing.
2532Citations go inside square brackets and are separated by semicolons.
2533Each citation must have a key, composed of '@' + the citation
2534identifier from the database, and may optionally have a prefix,
2535a locator, and a suffix. The citation key must begin with a letter
2536or `_`, and may contain alphanumerics, `_`, and internal punctuation
2537characters (`:.#$%&-+?<>~/`). Here are some examples:
2539 Blah blah [see @doe99, pp. 33-35; also @smith04, ch. 1].
2541 Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
2543 Blah blah [@smith04; @doe99].
2545A minus sign (`-`) before the `@` will suppress mention of
2546the author in the citation. This can be useful when the
2547author is already mentioned in the text:
2549 Smith says blah [-@smith04].
2551You can also write an in-text citation, as follows:
2555 @smith04 [p. 33] says blah.
2557If the style calls for a list of works cited, it will be placed
2558at the end of the document. Normally, you will want to end your
2559document with an appropriate header:
2565The bibliography will be inserted after this header. Note that
2566the `unnumbered` class will be added to this header, so that the
2567section will not be numbered.
2569If you want to include items in the bibliography without actually
2570citing them in the body text, you can define a dummy `nocite` metadata
2571field and put the citations there:
2580In this example, the document will contain a citation for `item3`
2581only, but the bibliography will contain entries for `item1`, `item2`, and
2584Non-pandoc extensions
2585---------------------
2587The following markdown syntax extensions are not enabled by default
2588in pandoc, but may be enabled by adding `+EXTENSION` to the format
2589name, where `EXTENSION` is the name of the extension. Thus, for
2590example, `markdown+hard_line_breaks` is markdown with hard line breaks.
2592**Extension: `lists_without_preceding_blankline`**\
2593Allow a list to occur right after a paragraph, with no intervening
2596**Extension: `hard_line_breaks`**\
2597Causes all newlines within a paragraph to be interpreted as hard line
2598breaks instead of spaces.
2600**Extension: `ignore_line_breaks`**\
2601Causes newlines within a paragraph to be ignored, rather than being
2602treated as spaces or as hard line breaks. This option is intended for
2603use with East Asian languages where spaces are not used between words,
2604but text is divided into lines for readability.
2606**Extension: `tex_math_single_backslash`**\
2607Causes anything between `\(` and `\)` to be interpreted as inline
2608TeX math, and anything between `\[` and `\]` to be interpreted
2609as display TeX math. Note: a drawback of this extension is that
2610it precludes escaping `(` and `[`.
2612**Extension: `tex_math_double_backslash`**\
2613Causes anything between `\\(` and `\\)` to be interpreted as inline
2614TeX math, and anything between `\\[` and `\\]` to be interpreted
2617**Extension: `markdown_attribute`**\
2618By default, pandoc interprets material inside block-level tags as markdown.
2619This extension changes the behavior so that markdown is only parsed
2620inside block-level tags if the tags have the attribute `markdown=1`.
2622**Extension: `mmd_title_block`**\
2623Enables a [MultiMarkdown] style title block at the top of
2624the document, for example:
2628 Date: September 1, 2008
2629 Comment: This is a sample mmd title block, with
2630 a field spanning multiple lines.
2632See the MultiMarkdown documentation for details. If `pandoc_title_block` or
2633`yaml_metadata_block` is enabled, it will take precedence over
2636 [MultiMarkdown]: http://fletcherpenney.net/multimarkdown/
2638**Extension: `abbreviations`**\
2639Parses PHP Markdown Extra abbreviation keys, like
2641 *[HTML]: Hyper Text Markup Language
2643Note that the pandoc document model does not support
2644abbreviations, so if this extension is enabled, abbreviation keys are
2645simply skipped (as opposed to being parsed as paragraphs).
2647**Extension: `autolink_bare_uris`**\
2648Makes all absolute URIs into links, even when not surrounded by
2649pointy braces `<...>`.
2651**Extension: `ascii_identifiers`**\
2652Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
2653Accents are stripped off of accented latin letters, and non-latin
2656**Extension: `link_attributes`**\
2657Parses multimarkdown style key-value attributes on link and image references.
2658Note that pandoc's internal document model provides nowhere to put
2659these, so they are presently just ignored.
2661**Extension: `mmd_header_identifiers`**\
2662Parses multimarkdown style header identifiers (in square brackets,
2663after the header but before any trailing `#`s in an ATX header).
2665**Extension: `compact_definition_lists`**\
2666Activates the definition list syntax of pandoc 1.12.x and earlier.
2667This syntax differs from the one described [above](#definition-lists)
2670 - No blank line is required between consecutive items of the
2672 - To get a "tight" or "compact" list, omit space between consecutive
2673 items; the space between a term and its definition does not affect
2675 - Lazy wrapping of paragraphs is not allowed: the entire definition must
2676 be indented four spaces.[^6]
2678[^6]: To see why laziness is incompatible with relaxing the requirement
2679 of a blank line between items, consider the following example:
2686 Is this a single list item with two definitions of "bar," the first of
2687 which is lazily wrapped, or two list items? To remove the ambiguity
2688 we must either disallow lazy wrapping or require a blank line between
2694In addition to pandoc's extended markdown, the following markdown
2695variants are supported:
2697`markdown_phpextra` (PHP Markdown Extra)
2698: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,
2699 `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,
2700 `header_attributes`, `abbreviations`.
2702`markdown_github` (Github-flavored Markdown)
2703: `pipe_tables`, `raw_html`, `tex_math_single_backslash`,
2704 `fenced_code_blocks`, `auto_identifiers`,
2705 `ascii_identifiers`, `backtick_code_blocks`, `autolink_bare_uris`,
2706 `intraword_underscores`, `strikeout`, `hard_line_breaks`
2708`markdown_mmd` (MultiMarkdown)
2709: `pipe_tables` `raw_html`, `markdown_attribute`, `link_attributes`,
2710 `raw_tex`, `tex_math_double_backslash`, `intraword_underscores`,
2711 `mmd_title_block`, `footnotes`, `definition_lists`,
2712 `all_symbols_escapable`, `implicit_header_references`,
2713 `auto_identifiers`, `mmd_header_identifiers`
2715`markdown_strict` (Markdown.pl)
2718Extensions with formats other than markdown
2719-------------------------------------------
2721Some of the extensions discussed above can be used with formats
2724* `auto_identifiers` can be used with `latex`, `rst`, `mediawiki`,
2725 and `textile` input (and is used by default).
2727* `tex_math_dollars`, `tex_math_single_backslash`, and
2728 `tex_math_double_backslash` can be used with `html` input.
2729 (This is handy for reading web pages formatted using MathJax,
2732Producing slide shows with Pandoc
2733=================================
2735You can use Pandoc to produce an HTML + javascript slide presentation
2736that can be viewed via a web browser. There are five ways to do this,
2737using [S5], [DZSlides], [Slidy], [Slideous], or [reveal.js].
2738You can also produce a PDF slide show using LaTeX [beamer].
2740Here's the markdown source for a simple slide show, `habits.txt`:
2767 
2774To produce an HTML/javascript slide show, simply type
2776 pandoc -t FORMAT -s habits.txt -o habits.html
2778where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
2780For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
2781`-s/--standalone` option embeds a link to javascripts and CSS files, which are
2782assumed to be available at the relative path `s5/default` (for S5), `slideous`
2783(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
2784`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
2785`slideous-url`, `revealjs-url`, or `s5-url` variables; see `--variable`,
2786above.) For DZSlides, the (relatively short) javascript and css are included in
2789With all HTML slide formats, the `--self-contained` option can be used to
2790produce a single file that contains all of the data necessary to display the
2791slide show, including linked scripts, stylesheets, images, and videos.
2793To produce a PDF slide show using beamer, type
2795 pandoc -t beamer habits.txt -o habits.pdf
2797Note that a reveal.js slide show can also be converted to a PDF
2798by printing it to a file from the browser.
2800Structuring the slide show
2801--------------------------
2803By default, the *slide level* is the highest header level in
2804the hierarchy that is followed immediately by content, and not another
2805header, somewhere in the document. In the example above, level 1 headers
2806are always followed by level 2 headers, which are followed by content,
2807so 2 is the slide level. This default can be overridden using
2808the `--slide-level` option.
2810The document is carved up into slides according to the following
2813 * A horizontal rule always starts a new slide.
2815 * A header at the slide level always starts a new slide.
2817 * Headers *below* the slide level in the hierarchy create
2818 headers *within* a slide.
2820 * Headers *above* the slide level in the hierarchy create
2821 "title slides," which just contain the section title
2822 and help to break the slide show into sections.
2824 * A title page is constructed automatically from the document's title
2825 block, if present. (In the case of beamer, this can be disabled
2826 by commenting out some lines in the default template.)
2828These rules are designed to support many different styles of slide show. If
2829you don't care about structuring your slides into sections and subsections,
2830you can just use level 1 headers for all each slide. (In that case, level 1
2831will be the slide level.) But you can also structure the slide show into
2832sections, as in the example above.
2834Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
2835layout will be produced, with level 1 headers building horizontally
2836and level 2 headers building vertically. It is not recommended that
2837you use deeper nesting of section levels with reveal.js.
2842By default, these writers produces lists that display "all at once."
2843If you want your lists to display incrementally (one item at a time),
2844use the `-i` option. If you want a particular list to depart from the
2845default (that is, to display incrementally without the `-i` option and
2846all at once with the `-i` option), put it in a block quote:
2851In this way incremental and nonincremental lists can be mixed in
2857You can add "pauses" within a slide by including a paragraph containing
2858three dots, separated by spaces:
2860 # Slide with a pause
2862 content before the pause
2866 content after the pause
2871You can change the style of HTML slides by putting customized CSS files
2872in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
2873or `$DATADIR/slideous` (for Slideous),
2874where `$DATADIR` is the user data directory (see `--data-dir`, above).
2875The originals may be found in pandoc's system data directory (generally
2876`$CABALDIR/pandoc-VERSION/s5/default`). Pandoc will look there for any
2877files it does not find in the user data directory.
2879For dzslides, the CSS is included in the HTML file itself, and may
2882For reveal.js, themes can be used by setting the `theme` variable,
2887Or you can specify a custom stylesheet using the `--css` option.
2889To style beamer slides, you can specify a beamer "theme" or "colortheme"
2890using the `-V` option:
2892 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
2894Note that header attributes will turn into slide attributes
2895(on a `<div>` or `<section>`) in HTML slide formats, allowing you
2896to style individual slides. In Beamer, the only header attribute
2897that affects slides is the `allowframebreaks` class, which sets the
2898`allowframebreaks` option, causing multiple slides to be created
2899if the content overfills the frame. This is recommended especially for
2902 # References {.allowframebreaks}
2907reveal.js has good support for speaker notes. You can add notes to your
2908markdown document thus:
2913 - It can contain markdown
2918To show the notes window, press `s` while viewing the presentation.
2919Notes are not yet supported for other slide formats, but the notes
2920will not appear on the slides themselves.
2925EPUB metadata may be specified using the `--epub-metadata` option, but
2926if the source document is markdown, it is better to use a YAML metadata
2927block. Here is an example:
2934 text: An investigation of metadata
2942 text: doi:10.234234.234/33
2944 rights: (c) 2007 John Smith, CC BY-NC
2947The following fields are recognized:
2950 ~ Either a string value or an object with fields `text` and
2951 `scheme`. Valid values for `scheme` are `ISBN-10`,
2952 `GTIN-13`, `UPC`, `ISMN-10`, `DOI`, `LCCN`, `GTIN-14`,
2953 `ISBN-13`, `Legal deposit number`, `URN`, `OCLC`,
2954 `ISMN-13`, `ISBN-A`, `JP`, `OLCC`.
2956 ~ Either a string value, or an object with fields `file-as` and
2957 `type`, or a list of such objects. Valid values for `type` are
2958 `main`, `subtitle`, `short`, `collection`, `edition`, `extended`.
2960 ~ Either a string value, or an object with fields `role`, `file-as`,
2961 and `text`, or a list of such objects. Valid values for `role` are
2962 [marc relators](http://www.loc.gov/marc/relators/relaterm.html), but
2963 pandoc will attempt to translate the human-readable versions
2964 (like "author" and "editor") to the appropriate marc relators.
2966 ~ Same format as `creator`.
2968 ~ A string value in `YYYY-MM-DD` format. (Only the year is necessary.)
2969 Pandoc will attempt to convert other common date formats.
2971 ~ A string value in [RFC5646] format. Pandoc will default to the local
2972 language if nothing is specified.
2974 ~ A string value or a list of such values.
2988 ~ A string value (path to cover image).
2990 ~ A string value (path to CSS stylesheet).
2992Literate Haskell support
2993========================
2995If you append `+lhs` (or `+literate_haskell`) to an appropriate input or output
2996format (`markdown`, `markdown_strict`, `rst`, or `latex` for input or output;
2997`beamer`, `html` or `html5` for output only), pandoc will treat the document as
2998literate Haskell source. This means that
3000 - In markdown input, "bird track" sections will be parsed as Haskell
3001 code rather than block quotations. Text between `\begin{code}`
3002 and `\end{code}` will also be treated as Haskell code.
3004 - In markdown output, code blocks with classes `haskell` and `literate`
3005 will be rendered using bird tracks, and block quotations will be
3006 indented one space, so they will not be treated as Haskell code.
3007 In addition, headers will be rendered setext-style (with underlines)
3008 rather than atx-style (with '#' characters). (This is because ghc
3009 treats '#' characters in column 1 as introducing line numbers.)
3011 - In restructured text input, "bird track" sections will be parsed
3014 - In restructured text output, code blocks with class `haskell` will
3015 be rendered using bird tracks.
3017 - In LaTeX input, text in `code` environments will be parsed as
3020 - In LaTeX output, code blocks with class `haskell` will be rendered
3021 inside `code` environments.
3023 - In HTML output, code blocks with class `haskell` will be rendered
3024 with class `literatehaskell` and bird tracks.
3028 pandoc -f markdown+lhs -t html
3030reads literate Haskell source formatted with markdown conventions and writes
3031ordinary HTML (without bird tracks).
3033 pandoc -f markdown+lhs -t html+lhs
3035writes HTML with the Haskell code in bird tracks, so it can be copied
3036and pasted as literate Haskell source.
3041Pandoc can be extended with custom writers written in [lua]. (Pandoc
3042includes a lua interpreter, so lua need not be installed separately.)
3044To use a custom writer, simply specify the path to the lua script
3045in place of the output format. For example:
3047 pandoc -t data/sample.lua
3049Creating a custom writer requires writing a lua function for each
3050possible element in a pandoc document. To get a documented example
3051which you can modify according to your needs, do
3053 pandoc --print-default-data-file sample.lua
3058© 2006-2013 John MacFarlane (jgm at berkeley dot edu). Released under the
3059[GPL], version 2 or greater. This software carries no warranty of
3060any kind. (See COPYRIGHT for full copyright and warranty notices.)
3061Other contributors include Recai Oktaş, Paulo Tanimoto, Peter Wang,
3062Andrea Rossato, Eric Kow, infinity0x, Luke Plant, shreevatsa.public,
3063Puneeth Chaganti, Paul Rivier, rodja.trappe, Bradley Kuhn, thsutton,
3064Nathan Gass, Jonathan Daugherty, Jérémy Bobbio, Justin Bogner, qerub,
3065Christopher Sawicki, Kelsey Hightower, Masayoshi Takahashi, Antoine
3066Latter, Ralf Stephan, Eric Seidel, B. Scott Michel, Gavin Beatty,
3067Sergey Astanin, Arlo O'Keeffe, Denis Laxalde, Brent Yorgey, David Lazar,
3068Jamie F. Olson, Matthew Pickering, Albert Krewinkel, mb21, Jesse
3071[markdown]: http://daringfireball.net/projects/markdown/
3072[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html
3073[S5]: http://meyerweb.com/eric/tools/s5/
3074[Slidy]: http://www.w3.org/Talks/Tools/Slidy/
3075[Slideous]: http://goessner.net/articles/slideous/
3076[HTML]: http://www.w3.org/TR/html40/
3077[HTML 5]: http://www.w3.org/TR/html5/
3078[XHTML]: http://www.w3.org/TR/xhtml1/
3079[LaTeX]: http://www.latex-project.org/
3080[beamer]: http://www.tex.ac.uk/CTAN/macros/latex/contrib/beamer
3081[ConTeXt]: http://www.pragma-ade.nl/
3082[RTF]: http://en.wikipedia.org/wiki/Rich_Text_Format
3083[DocBook]: http://www.docbook.org/
3084[OPML]: http://dev.opml.org/spec2.html
3085[OpenDocument]: http://opendocument.xml.org/
3086[ODT]: http://en.wikipedia.org/wiki/OpenDocument
3087[Textile]: http://redcloth.org/textile
3088[MediaWiki markup]: http://www.mediawiki.org/wiki/Help:Formatting
3089[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
3090[Haddock markup]: http://www.haskell.org/haddock/doc/html/ch03s08.html
3091[groff man]: http://developer.apple.com/DOCUMENTATION/Darwin/Reference/ManPages/man7/groff_man.7.html
3092[Haskell]: http://www.haskell.org/
3093[GNU Texinfo]: http://www.gnu.org/software/texinfo/
3094[Emacs Org-Mode]: http://orgmode.org
3095[AsciiDoc]: http://www.methods.co.nz/asciidoc/
3096[EPUB]: http://www.idpf.org/
3097[GPL]: http://www.gnu.org/copyleft/gpl.html "GNU General Public License"
3098[DZSlides]: http://paulrouget.com/dzslides/
3099[ISO 8601 format]: http://www.w3.org/TR/NOTE-datetime
3100[Word docx]: http://www.microsoft.com/interop/openup/openxml/default.aspx
3101[PDF]: http://www.adobe.com/pdf/
3102[reveal.js]: http://lab.hakim.se/reveal-js/
3103[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
3104[lua]: http://www.lua.org
3105[marc relators]: http://www.loc.gov/marc/relators/relaterm.html
3106[RFC5646]: http://tools.ietf.org/html/rfc5646
3107[InDesign ICML]: https://www.adobe.com/content/dam/Adobe/en/devnet/indesign/cs55-docs/IDML/idml-specification.pdf
3108[txt2tags]: http://txt2tags.org/
keysesc to close
- j k
- move down, up
- enter
- open
- esc
- back, or up a level
- 1 2 3 4
- readme, files, commits, refs
- /
- filter
- y
- copy the clone command
- c
- compare the chosen commit with another (or shift-click both)
- ?
- show or hide this list