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], and [DocBook]; and
17it can write plain text, [markdown], [reStructuredText], [XHTML], [HTML 5],
18[LaTeX] (including [beamer] slide shows), [ConTeXt], [RTF], [OPML], [DocBook],
19[OpenDocument], [ODT], [Word docx], [GNU Texinfo], [MediaWiki markup],
20[EPUB] (v2 or v3), [FictionBook2], [Textile], [groff man] pages, [Emacs
21Org-Mode], [AsciiDoc], and [Slidy], [Slideous], [DZSlides], [reveal.js]
22or [S5] HTML slide shows. It can also produce [PDF] output on systems
23where LaTeX is installed.
25Pandoc's enhanced version of markdown includes syntax for footnotes,
26tables, flexible ordered lists, definition lists, fenced code blocks,
27superscript, subscript, strikeout, title blocks, automatic tables of
28contents, embedded LaTeX math, citations, and markdown inside HTML block
29elements. (These enhancements, described below under
30[Pandoc's markdown](#pandocs-markdown), can be disabled using the
31`markdown_strict` input or output format.)
33In contrast to most existing tools for converting markdown to HTML, which
34use regex substitutions, Pandoc has a modular design: it consists of a
35set of readers, which parse text in a given format and produce a native
36representation of the document, and a set of writers, which convert
37this native representation into a target format. Thus, adding an input
38or output format requires only adding a reader or writer.
43If no *input-file* is specified, input is read from *stdin*.
44Otherwise, the *input-files* are concatenated (with a blank
45line between each) and used as input. Output goes to *stdout* by
46default (though output to *stdout* is disabled for the `odt`, `docx`,
47`epub`, and `epub3` output formats). For output to a file, use the
50 pandoc -o output.html input.txt
52Instead of a file, an absolute URI may be given. In this case
53pandoc will fetch the content using HTTP:
55 pandoc -f html -t markdown http://www.fsf.org
57If multiple input files are given, `pandoc` will concatenate them all (with
58blank lines between them) before parsing.
60The format of the input and output can be specified explicitly using
61command-line options. The input format can be specified using the
62`-r/--read` or `-f/--from` options, the output format using the
63`-w/--write` or `-t/--to` options. Thus, to convert `hello.txt` from
64markdown to LaTeX, you could type:
66 pandoc -f markdown -t latex hello.txt
68To convert `hello.html` from html to markdown:
70 pandoc -f html -t markdown hello.html
72Supported output formats are listed below under the `-t/--to` option.
73Supported input formats are listed below under the `-f/--from` option. Note
74that the `rst`, `textile`, `latex`, and `html` readers are not complete;
75there are some constructs that they do not parse.
77If the input or output format is not specified explicitly, `pandoc`
78will attempt to guess it from the extensions of
79the input and output filenames. Thus, for example,
81 pandoc -o hello.tex hello.txt
83will convert `hello.txt` from markdown to LaTeX. If no output file
84is specified (so that output goes to *stdout*), or if the output file's
85extension is unknown, the output format will default to HTML.
86If no input file is specified (so that input comes from *stdin*), or
87if the input files' extensions are unknown, the input format will
88be assumed to be markdown unless explicitly specified.
90Pandoc uses the UTF-8 character encoding for both input and output.
91If your local character encoding is not UTF-8, you
92should pipe input and output through `iconv`:
94 iconv -t utf-8 input.txt | pandoc | iconv -f utf-8
99Earlier versions of pandoc came with a program, `markdown2pdf`, that
100used pandoc and pdflatex to produce a PDF. This is no longer needed,
101since `pandoc` can now produce `pdf` output itself. To produce a PDF, simply
102specify an output file with a `.pdf` extension. Pandoc will create a latex
103file and use pdflatex (or another engine, see `--latex-engine`) to convert it
106 pandoc test.txt -o test.pdf
108Production of a PDF requires that a LaTeX engine be installed (see
109`--latex-engine`, below), and assumes that the following LaTeX packages are
110available: `amssymb`, `amsmath`, `ifxetex`, `ifluatex`, `listings` (if the
111`--listings` option is used), `fancyvrb`, `longtable`, `url`,
112`graphicx`, `hyperref`, `ulem`, `babel` (if the `lang` variable is set),
113`fontspec` (if `xelatex` or `lualatex` is used as the LaTeX engine), `xltxtra`
114and `xunicode` (if `xelatex` is used).
119A user who wants a drop-in replacement for `Markdown.pl` may create
120a symbolic link to the `pandoc` executable called `hsmarkdown`. When
121invoked under the name `hsmarkdown`, `pandoc` will behave as if
122invoked with `-f markdown_strict --email-obfuscation=references`,
123and all command-line options will be treated as regular arguments.
124However, this approach does not work under Cygwin, due to problems with
125its simulation of symbolic links.
127[Cygwin]: http://www.cygwin.com/
128[`iconv`]: http://www.gnu.org/software/libiconv/
129[CTAN]: http://www.ctan.org "Comprehensive TeX Archive Network"
130[TeX Live]: http://www.tug.org/texlive/
131[MacTeX]: http://www.tug.org/mactex/
139`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*
140: Specify input format. *FORMAT* can be `native` (native Haskell),
141 `json` (JSON version of native AST), `markdown` (pandoc's
142 extended markdown), `markdown_strict` (original unextended markdown),
143 `markdown_phpextra` (PHP Markdown Extra extended markdown),
144 `markdown_github` (github extended markdown),
145 `textile` (Textile), `rst` (reStructuredText), `html` (HTML),
146 `docbook` (DocBook), `opml` (OPML), `mediawiki` (MediaWiki markup),
147 `haddock` (Haddock markup), or `latex` (LaTeX).
148 If `+lhs` is appended to `markdown`, `rst`, `latex`, or `html`,
149 the input will be treated as literate Haskell source:
150 see [Literate Haskell support](#literate-haskell-support), below.
151 Markdown syntax extensions can be individually enabled or disabled
152 by appending `+EXTENSION` or `-EXTENSION` to the format name.
153 So, for example, `markdown_strict+footnotes+definition_lists`
154 is strict markdown with footnotes and definition lists enabled,
155 and `markdown-pipe_tables+hard_line_breaks` is pandoc's markdown
156 without pipe tables and with hard line breaks. See [Pandoc's
157 markdown](#pandocs-markdown), below, for a list of extensions and
160`-t` *FORMAT*, `-w` *FORMAT*, `--to=`*FORMAT*, `--write=`*FORMAT*
161: Specify output format. *FORMAT* can be `native` (native Haskell),
162 `json` (JSON version of native AST), `plain` (plain text),
163 `markdown` (pandoc's extended markdown), `markdown_strict` (original
164 unextended markdown), `markdown_phpextra` (PHP Markdown extra
165 extended markdown), `markdown_github` (github extended markdown),
166 `rst` (reStructuredText), `html` (XHTML 1), `html5` (HTML 5),
167 `latex` (LaTeX), `beamer` (LaTeX beamer slide show),
168 `context` (ConTeXt), `man` (groff man), `mediawiki` (MediaWiki markup),
169 `textile` (Textile), `org` (Emacs Org-Mode), `texinfo` (GNU Texinfo),
170 `opml` (OPML), `docbook` (DocBook), `opendocument` (OpenDocument), `odt`
171 (OpenOffice text document), `docx` (Word docx),
172 `rtf` (rich text format), `epub` (EPUB v2 book), `epub3`
173 (EPUB v3), `fb2` (FictionBook2 e-book), `asciidoc` (AsciiDoc), `slidy`
174 (Slidy HTML and javascript slide show), `slideous` (Slideous HTML and
175 javascript slide show), `dzslides` (DZSlides HTML5 + javascript slide
176 show), `revealjs` (reveal.js HTML5 + javascript slide show), `s5`
177 (S5 HTML and javascript slide show), or the path of a custom
178 lua writer (see [Custom writers](#custom-writers), below). Note that
179 `odt`, `epub`, and `epub3` output will not be directed to *stdout*; an
180 output filename must be specified using the `-o/--output` option. If
181 `+lhs` is appended to `markdown`, `rst`, `latex`, `beamer`, `html`, or
182 `html5`, the output will be rendered as literate Haskell source: see
183 [Literate Haskell support](#literate-haskell-support), below. Markdown
184 syntax extensions can be individually enabled or disabled by appending
185 `+EXTENSION` or `-EXTENSION` to the format name, as described above
188`-o` *FILE*, `--output=`*FILE*
189: Write output to *FILE* instead of *stdout*. If *FILE* is
190 `-`, output will go to *stdout*. (Exception: if the output
191 format is `odt`, `docx`, `epub`, or `epub3`, output to stdout is disabled.)
193`--data-dir=`*DIRECTORY*
194: Specify the user data directory to search for pandoc data files.
195 If this option is not specified, the default user data directory
196 will be used. This is
202 C:\Documents And Settings\USERNAME\Application Data\pandoc
206 C:\Users\USERNAME\AppData\Roaming\pandoc
208 in Windows 7. (You can find the default user data directory
209 on your system by looking at the output of `pandoc --version`.)
210 A `reference.odt`, `reference.docx`, `default.csl`,
211 `epub.css`, `templates`, `slidy`, `slideous`, or `s5` directory
212 placed in this directory will override pandoc's normal defaults.
224: Parse untranslatable HTML codes and LaTeX environments as raw HTML
225 or LaTeX, instead of ignoring them. Affects only HTML and LaTeX
226 input. Raw HTML can be printed in markdown, reStructuredText, HTML,
227 Slidy, Slideous, DZSlides, reveal.js, and S5 output; raw LaTeX
228 can be printed in markdown, reStructuredText, LaTeX, and ConTeXt output.
229 The default is for the readers to omit untranslatable HTML codes and
230 LaTeX environments. (The LaTeX reader does pass through untranslatable
231 LaTeX *commands*, even if `-R` is not specified.)
234: Produce typographically correct output, converting straight quotes
235 to curly quotes, `---` to em-dashes, `--` to en-dashes, and
236 `...` to ellipses. Nonbreaking spaces are inserted after certain
237 abbreviations, such as "Mr." (Note: This option is significant only when
238 the input format is `markdown`, `markdown_strict`, or `textile`. It
239 is selected automatically when the input format is `textile` or the
240 output format is `latex` or `context`, unless `--no-tex-ligatures`
244: Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes: `-` before
245 a numeral is an en-dash, and `--` is an em-dash. This option is selected
246 automatically for `textile` input.
248`--base-header-level=`*NUMBER*
249: Specify the base level for headers (defaults to 1).
251`--indented-code-classes=`*CLASSES*
252: Specify classes to use for indented code blocks--for example,
253 `perl,numberLines` or `haskell`. Multiple classes may be separated
256`--default-image-extension=`*EXTENSION*
257: Specify a default extension to use when image paths/URLs have no
258 extension. This allows you to use the same source for formats that
259 require different kinds of images. Currently this option only affects
260 the markdown and LaTeX readers.
262`--filter=`*EXECUTABLE*
263: Specify an executable to be used as a filter transforming the
264 Pandoc AST after the input is parsed and before the output is
265 written. The executable should read JSON from stdin and write
266 JSON to stdout. The JSON must be formatted like pandoc's own
267 JSON input and output. The name of the output format will be
268 passed to the filter as the first argument. Hence,
270 pandoc --filter ./caps.py -t latex
274 pandoc -t json | ./caps.py latex | pandoc -f json -t latex
276 The latter form may be useful for debugging filters.
278 Filters may be written in any language. `Text.Pandoc.JSON`
279 exports `toJSONFilter` to facilitate writing filters in Haskell.
280 Those who would prefer to write filters in pandoc can use the
281 module `pandoc.py`: see <http://github.com/jgm/pandoc-filters-python>
282 for the module and several examples. Note that the *EXECUTABLE*
283 will be sought in the user's `PATH`, and not in the working directory,
284 if no directory is provided. If you want to run a script in the
285 working directory, preface the filename with `./`.
288: Normalize the document after reading: merge adjacent
289 `Str` or `Emph` elements, for example, and remove repeated `Space`s.
291`-p`, `--preserve-tabs`
292: Preserve tabs instead of converting them to spaces (the default).
293 Note that this will only affect tabs in literal code spans and code
294 blocks; tabs in regular text will be treated as spaces.
297: Specify the number of spaces per tab (default is 4).
299General writer options
300----------------------
303: Produce output with an appropriate header and footer (e.g. a
304 standalone HTML, LaTeX, or RTF file, not a fragment). This option
305 is set automatically for `pdf`, `epub`, `epub3`, `fb2`, `docx`, and `odt`
309: Use *FILE* as a custom template for the generated document. Implies
310 `--standalone`. See [Templates](#templates) below for a description
311 of template syntax. If no extension is specified, an extension
312 corresponding to the writer will be added, so that `--template=special`
313 looks for `special.html` for HTML output. If the template is not
314 found, pandoc will search for it in the user data directory
315 (see `--data-dir`). If this option is not used, a default
316 template appropriate for the output format will be used (see
317 `-D/--print-default-template`).
319`-V` *KEY[=VAL]*, `--variable=`*KEY[:VAL]*
320: Set the template variable *KEY* to the value *VAL* when rendering the
321 document in standalone mode. This is generally only useful when the
322 `--template` option is used to specify a custom template, since
323 pandoc automatically sets the variables used in the default
324 templates. If no *VAL* is specified, the key will be given the
327`-D` *FORMAT*, `--print-default-template=`*FORMAT*
328: Print the default template for an output *FORMAT*. (See `-t`
329 for a list of possible *FORMAT*s.)
331`--print-default-data-file=`*FILE*
332: Print a default data file.
335: Disable text wrapping in output. By default, text is wrapped
336 appropriately for the output format.
339: Specify length of lines in characters (for text wrapping).
341`--toc`, `--table-of-contents`
342: Include an automatically generated table of contents (or, in
343 the case of `latex`, `context`, and `rst`, an instruction to create
344 one) in the output document. This option has no effect on `man`,
345 `docbook`, `slidy`, `slideous`, or `s5` output.
347`--toc-depth=`*NUMBER*
348: Specify the number of section levels to include in the table
349 of contents. The default is 3 (which means that level 1, 2, and 3
350 headers will be listed in the contents).
353: Disables syntax highlighting for code blocks and inlines, even when
354 a language attribute is given.
356`--highlight-style`=*STYLE*
357: Specifies the coloring style to be used in highlighted source code.
358 Options are `pygments` (the default), `kate`, `monochrome`,
359 `espresso`, `zenburn`, `haddock`, and `tango`.
361`-H` *FILE*, `--include-in-header=`*FILE*
362: Include contents of *FILE*, verbatim, at the end of the header.
363 This can be used, for example, to include special
364 CSS or javascript in HTML documents. This option can be used
365 repeatedly to include multiple files in the header. They will be
366 included in the order specified. Implies `--standalone`.
368`-B` *FILE*, `--include-before-body=`*FILE*
369: Include contents of *FILE*, verbatim, at the beginning of the
370 document body (e.g. after the `<body>` tag in HTML, or the
371 `\begin{document}` command in LaTeX). This can be used to include
372 navigation bars or banners in HTML documents. This option can be
373 used repeatedly to include multiple files. They will be included in
374 the order specified. Implies `--standalone`.
376`-A` *FILE*, `--include-after-body=`*FILE*
377: Include contents of *FILE*, verbatim, at the end of the document
378 body (before the `</body>` tag in HTML, or the
379 `\end{document}` command in LaTeX). This option can be be used
380 repeatedly to include multiple files. They will be included in the
381 order specified. Implies `--standalone`.
383Options affecting specific writers
384----------------------------------
387: Produce a standalone HTML file with no external dependencies, using
388 `data:` URIs to incorporate the contents of linked scripts, stylesheets,
389 images, and videos. The resulting file should be "self-contained,"
390 in the sense that it needs no external files and no net access to be
391 displayed properly by a browser. This option works only with HTML output
392 formats, including `html`, `html5`, `html+lhs`, `html5+lhs`, `s5`,
393 `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images, and
394 stylesheets at absolute URLs will be downloaded; those at relative URLs
395 will be sought first relative to the working directory, then relative to
396 the user data directory (see `--data-dir`), and finally relative to
397 pandoc's default data directory. `--self-contained` does not
398 work with `--mathjax`.
401: Deprecated synonym for `--self-contained`.
404: Produce HTML5 instead of HTML4. This option has no effect for writers
405 other than `html`. (*Deprecated:* Use the `html5` output format instead.)
408: Use `<q>` tags for quotes in HTML.
411: Use only ascii characters in output. Currently supported only
412 for HTML output (which uses numerical entities instead of
413 UTF-8 when this option is selected).
416: Use reference-style links, rather than inline links, in writing markdown
417 or reStructuredText. By default inline links are used.
420: Use ATX style headers in markdown and asciidoc output. The default is
421 to use setext-style headers for levels 1-2, and then ATX headers.
424: Treat top-level headers as chapters in LaTeX, ConTeXt, and DocBook
425 output. When the LaTeX template uses the report, book, or
426 memoir class, this option is implied. If `--beamer` is used,
427 top-level headers will become `\part{..}`.
429`-N`, `--number-sections`
430: Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.
431 By default, sections are not numbered. Sections with class
432 `unnumbered` will never be numbered, even if `--number-sections`
435`--number-offset`=*NUMBER[,NUMBER,...]*,
436: Offset for section headings in HTML output (ignored in other
437 output formats). The first number is added to the section number for
438 top-level headers, the second for second-level headers, and so on.
439 So, for example, if you want the first top-level header in your
440 document to be numbered "6", specify `--number-offset=5`.
441 If your document starts with a level-2 header which you want to
442 be numbered "1.5", specify `--number-offset=1,4`.
443 Offsets are 0 by default. Implies `--number-sections`.
446: Do not convert quotation marks, apostrophes, and dashes to
447 the TeX ligatures when writing LaTeX or ConTeXt. Instead, just
448 use literal unicode characters. This is needed for using advanced
449 OpenType features with XeLaTeX and LuaLaTeX. Note: normally
450 `--smart` is selected automatically for LaTeX and ConTeXt
451 output, but it must be specified explicitly if `--no-tex-ligatures`
452 is selected. If you use literal curly quotes, dashes, and ellipses
453 in your source, then you may want to use `--no-tex-ligatures`
457: Use listings package for LaTeX code blocks
460: Make list items in slide shows display incrementally (one by one).
461 The default is for lists to be displayed all at once.
463`--slide-level`=*NUMBER*
464: Specifies that headers with the specified level create
465 slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headers
466 above this level in the hierarchy are used to divide the
467 slide show into sections; headers below this level create
468 subheads within a slide. The default is to set the slide level
469 based on the contents of the document; see
470 [Structuring the slide show](#structuring-the-slide-show), below.
473: Wrap sections in `<div>` tags (or `<section>` tags in HTML5),
474 and attach identifiers to the enclosing `<div>` (or `<section>`)
475 rather than the header itself.
476 See [Section identifiers](#header-identifiers-in-html-latex-and-context), below.
478`--email-obfuscation=`*none|javascript|references*
479: Specify a method for obfuscating `mailto:` links in HTML documents.
480 *none* leaves `mailto:` links as they are. *javascript* obfuscates
481 them using javascript. *references* obfuscates them by printing their
482 letters as decimal or hexadecimal character references.
484`--id-prefix`=*STRING*
485: Specify a prefix to be added to all automatically generated identifiers
486 in HTML and DocBook output, and to footnote numbers in markdown output.
487 This is useful for preventing duplicate identifiers when generating
488 fragments to be included in other pages.
490`-T` *STRING*, `--title-prefix=`*STRING*
491: Specify *STRING* as a prefix at the beginning of the title
492 that appears in the HTML header (but not in the title as it
493 appears at the beginning of the HTML body). Implies
496`-c` *URL*, `--css=`*URL*
497: Link to a CSS style sheet. This option can be be used repeatedly to
498 include multiple files. They will be included in the order specified.
500`--reference-odt=`*FILE*
501: Use the specified file as a style reference in producing an ODT.
502 For best results, the reference ODT should be a modified version
503 of an ODT produced using pandoc. The contents of the reference ODT
504 are ignored, but its stylesheets are used in the new ODT. If no
505 reference ODT is specified on the command line, pandoc will look
506 for a file `reference.odt` in the user data directory (see
507 `--data-dir`). If this is not found either, sensible defaults will be
510`--reference-docx=`*FILE*
511: Use the specified file as a style reference in producing a docx file.
512 For best results, the reference docx should be a modified version
513 of a docx file produced using pandoc. The contents of the reference docx
514 are ignored, but its stylesheets are used in the new docx. If no
515 reference docx is specified on the command line, pandoc will look
516 for a file `reference.docx` in the user data directory (see
517 `--data-dir`). If this is not found either, sensible defaults will be
518 used. The following styles are used by pandoc: [paragraph]
519 Normal, Compact, Title, Authors, Date, Heading 1, Heading 2, Heading 3,
520 Heading 4, Heading 5, Block Quote, Definition Term, Definition,
521 Body Text, Table Caption, Image Caption; [character] Default
522 Paragraph Font, Body Text Char, Verbatim Char, Footnote Ref,
525`--epub-stylesheet=`*FILE*
526: Use the specified CSS file to style the EPUB. If no stylesheet
527 is specified, pandoc will look for a file `epub.css` in the
528 user data directory (see `--data-dir`). If it is not
529 found there, sensible defaults will be used.
531`--epub-cover-image=`*FILE*
532: Use the specified image as the EPUB cover. It is recommended
533 that the image be less than 1000px in width and height.
535`--epub-metadata=`*FILE*
536: Look in the specified XML file for metadata for the EPUB.
537 The file should contain a series of Dublin Core elements,
538 as documented at <http://dublincore.org/documents/dces/>.
541 <dc:rights>Creative Commons</dc:rights>
542 <dc:language>es-AR</dc:language>
544 By default, pandoc will include the following metadata elements:
545 `<dc:title>` (from the document title), `<dc:creator>` (from the
546 document authors), `<dc:date>` (from the document date, which should
547 be in [ISO 8601 format]), `<dc:language>` (from the `lang`
548 variable, or, if is not set, the locale), and `<dc:identifier
549 id="BookId">` (a randomly generated UUID). Any of these may be
550 overridden by elements in the metadata file.
552`--epub-embed-font=`*FILE*
553: Embed the specified font in the EPUB. This option can be repeated
554 to embed multiple fonts. To use embedded fonts, you
555 will need to add declarations like the following to your CSS (see
556 `--epub-stylesheet`):
559 font-family: DejaVuSans;
562 src:url("DejaVuSans-Regular.ttf");
565 font-family: DejaVuSans;
568 src:url("DejaVuSans-Bold.ttf");
571 font-family: DejaVuSans;
574 src:url("DejaVuSans-Oblique.ttf");
577 font-family: DejaVuSans;
580 src:url("DejaVuSans-BoldOblique.ttf");
582 body { font-family: "DejaVuSans"; }
584`--epub-chapter-level=`*NUMBER*
585: Specify the header level at which to split the EPUB into separate
586 "chapter" files. The default is to split into chapters at level 1
587 headers. This option only affects the internal composition of the
588 EPUB, not the way chapters and sections are displayed to users. Some
589 readers may be slow if the chapter files are too large, so for large
590 documents with few level 1 headers, one might want to use a chapter
593`--latex-engine=`*pdflatex|lualatex|xelatex*
594: Use the specified LaTeX engine when producing PDF output.
595 The default is `pdflatex`. If the engine is not in your PATH,
596 the full path of the engine may be specified here.
602: Use natbib for citations in LaTeX output.
605: Use biblatex for citations in LaTeX output.
607Math rendering in HTML
608----------------------
610`-m` [*URL*], `--latexmathml`[=*URL*]
611: Use the [LaTeXMathML] script to display embedded TeX math in HTML output.
612 To insert a link to a local copy of the `LaTeXMathML.js` script,
613 provide a *URL*. If no *URL* is provided, the contents of the
614 script will be inserted directly into the HTML header, preserving
615 portability at the price of efficiency. If you plan to use math on
616 several pages, it is much better to link to a copy of the script,
620: Convert TeX math to MathML (in `docbook` as well as `html` and `html5`).
621 In standalone `html` output, a small javascript (or a link to such a
622 script if a *URL* is supplied) will be inserted that allows the MathML to
623 be viewed on some browsers.
626: Use [jsMath] to display embedded TeX math in HTML output.
627 The *URL* should point to the jsMath load script (e.g.
628 `jsMath/easy/load.js`); if provided, it will be linked to in
629 the header of standalone HTML documents. If a *URL* is not provided,
630 no link to the jsMath load script will be inserted; it is then
631 up to the author to provide such a link in the HTML template.
634: Use [MathJax] to display embedded TeX math in HTML output.
635 The *URL* should point to the `MathJax.js` load script.
636 If a *URL* is not provided, a link to the MathJax CDN will
640: Enclose TeX math in `<eq>` tags in HTML output. These can then
641 be processed by [gladTeX] to produce links to images of the typeset
645: Render TeX math using the [mimeTeX] CGI script. If *URL* is not
646 specified, it is assumed that the script is at `/cgi-bin/mimetex.cgi`.
649: Render TeX formulas using an external script that converts TeX
650 formulas to images. The formula will be concatenated with the URL
651 provided. If *URL* is not specified, the Google Chart API will be used.
653Options for wrapper scripts
654---------------------------
657: Print information about command-line arguments to *stdout*, then exit.
658 This option is intended primarily for use in wrapper scripts.
659 The first line of output contains the name of the output file specified
660 with the `-o` option, or `-` (for *stdout*) if no output file was
661 specified. The remaining lines contain the command-line arguments,
662 one per line, in the order they appear. These do not include regular
663 Pandoc options and their arguments, but do include any options appearing
664 after a `--` separator at the end of the line.
667: Ignore command-line arguments (for use in wrapper scripts).
668 Regular Pandoc options are not ignored. Thus, for example,
670 pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1
674 pandoc -o foo.html -s
676[LaTeXMathML]: http://math.etsu.edu/LaTeXMathML/
677[jsMath]: http://www.math.union.edu/~dpvc/jsmath/
678[MathJax]: http://www.mathjax.org/
679[gladTeX]: http://ans.hsh.no/home/mgg/gladtex/
680[mimeTeX]: http://www.forkosh.com/mimetex.html
681[CSL]: http://CitationStyles.org
686When the `-s/--standalone` option is used, pandoc uses a template to
687add header and footer material that is needed for a self-standing
688document. To see the default template that is used, just type
692where `FORMAT` is the name of the output format. A custom template
693can be specified using the `--template` option. You can also override
694the system default templates for a given output format `FORMAT`
695by putting a file `templates/default.FORMAT` in the user data
696directory (see `--data-dir`, above). *Exceptions:* For `odt` output,
697customize the `default.opendocument` template. For `pdf` output,
698customize the `default.latex` template.
700Templates may contain *variables*. Variable names are sequences of
701alphanumerics, `-`, and `_`, starting with a letter. A variable name
702surrounded by `$` signs will be replaced by its value. For example,
703the string `$title$` in
705 <title>$title$</title>
707will be replaced by the document title.
709To write a literal `$` in a template, use `$$`.
711Some variables are set automatically by pandoc. These vary somewhat
712depending on the output format, but include metadata fields (such
713as `title`, `author`, and `date`) as well as the following:
716: contents specified by `-H/--include-in-header` (may have multiple
719: non-null value if `--toc/--table-of-contents` was specified
721: contents specified by `-B/--include-before-body` (may have
724: contents specified by `-A/--include-after-body` (may have
729: language code for HTML or LaTeX documents
731: base URL for Slidy documents (defaults to
732 `http://www.w3.org/Talks/Tools/Slidy2`)
734: base URL for Slideous documents (defaults to `default`)
736: base URL for S5 documents (defaults to `ui/default`)
738: base URL for reveal.js documents (defaults to `reveal.js`)
740: reveal.js or LaTeX beamer theme
742: reveal.js transition
744: font size (10pt, 11pt, 12pt) for LaTeX documents
746: document class for LaTeX documents
748: option for LaTeX documentclass, e.g. `oneside`; may be repeated
751: options for LaTeX `geometry` class, e.g. `margin=1in`;
752 may be repeated for multiple options
753`mainfont`, `sansfont`, `monofont`, `mathfont`
754: fonts for LaTeX documents (works only with xelatex
757: colortheme for LaTeX beamer documents
759: fonttheme for LaTeX beamer documents
761: color for internal links in LaTeX documents (`red`, `green`,
762 `magenta`, `cyan`, `blue`, `black`)
764: color for external links in LaTeX documents
766: color for citation links in LaTeX documents
768: causes links to be printed as footnotes in LaTeX documents
770: bibliography style in LaTeX, when used with `--natbib`
772: section number in man pages
778Variables may be set at the command line using the `-V/--variable`
779option. Variables set in this way override metadata fields with
782Templates may contain conditionals. The syntax is as follows:
790This will include `X` in the template if `variable` has a non-null
791value; otherwise it will include `Y`. `X` and `Y` are placeholders for
792any valid template text, and may include interpolated variables or other
793conditionals. The `$else$` section may be omitted.
795When variables can have multiple values (for example, `author` in
796a multi-author document), you can use the `$for$` keyword:
799 <meta name="author" content="$author$" />
802You can optionally specify a separator to be used between
805 $for(author)$$author$$sep$, $endfor$
807A dot can be used to select a field of a variable that takes
808an object as its value. So, for example:
810 $author.name$ ($author.affiliation$)
812If you use custom templates, you may need to revise them as pandoc
813changes. We recommend tracking the changes in the default templates,
814and modifying your custom templates accordingly. An easy way to do this
815is to fork the pandoc-templates repository
816(<http://github.com/jgm/pandoc-templates>) and merge in changes after each
822Pandoc understands an extended and slightly revised version of
823John Gruber's [markdown] syntax. This document explains the syntax,
824noting differences from standard markdown. Except where noted, these
825differences can be suppressed by using the `markdown_strict` format instead
826of `markdown`. An extensions can be enabled by adding `+EXTENSION`
827to the format name and disabled by adding `-EXTENSION`. For example,
828`markdown_strict+footnotes` is strict markdown with footnotes
829enabled, while `markdown-footnotes-pipe_tables` is pandoc's
830markdown without footnotes or pipe tables.
835Markdown is designed to be easy to write, and, even more importantly,
838> A Markdown-formatted document should be publishable as-is, as plain
839> text, without looking like it's been marked up with tags or formatting
841> -- [John Gruber](http://daringfireball.net/projects/markdown/syntax#philosophy)
843This principle has guided pandoc's decisions in finding syntax for
844tables, footnotes, and other extensions.
846There is, however, one respect in which pandoc's aims are different
847from the original aims of markdown. Whereas markdown was originally
848designed with HTML generation in mind, pandoc is designed for multiple
849output formats. Thus, while pandoc allows the embedding of raw HTML,
850it discourages it, and provides other, non-HTMLish ways of representing
851important document elements like definition lists, tables, mathematics, and
857A paragraph is one or more lines of text followed by one or more blank line.
858Newlines are treated as spaces, so you can reflow your paragraphs as you like.
859If you need a hard line break, put two or more spaces at the end of a line.
861**Extension: `escaped_line_breaks`**
863A backslash followed by a newline is also a hard line break.
868There are two kinds of headers, Setext and atx.
870### Setext-style headers ###
872A setext-style header is a line of text "underlined" with a row of `=` signs
873(for a level one header) or `-` signs (for a level two header):
881The header text can contain inline formatting, such as emphasis (see
882[Inline formatting](#inline-formatting), below).
885### Atx-style headers ###
887An Atx-style header consists of one to six `#` signs and a line of
888text, optionally followed by any number of `#` signs. The number of
889`#` signs at the beginning of the line is the header level:
891 ## A level-two header
893 ### A level-three header ###
895As with setext-style headers, the header text can contain formatting:
897 # A level-one header with a [link](/url) and *emphasis*
899**Extension: `blank_before_header`**
901Standard markdown syntax does not require a blank line before a header.
902Pandoc does require this (except, of course, at the beginning of the
903document). The reason for the requirement is that it is all too easy for a
904`#` to end up at the beginning of a line by accident (perhaps through line
905wrapping). Consider, for example:
907 I like several of their flavors of ice cream:
908 #22, for example, and #5.
911### Header identifiers in HTML, LaTeX, and ConTeXt ###
913**Extension: `header_attributes`**
915Headers can be assigned attributes using this syntax at the end
916of the line containing the header text:
918 {#identifier .class .class key=value key=value}
920Although this syntax allows assignment of classes and key/value attributes,
921only identifiers currently have any affect in the writers (and only in some
922writers: HTML, LaTeX, ConTeXt, Textile, AsciiDoc). Thus, for example,
923the following headers will all be assigned the identifier `foo`:
927 ## My header ## {#foo}
929 My other header {#foo}
932(This syntax is compatible with [PHP Markdown Extra].)
934Headers with the class `unnumbered` will not be numbered, even if
935`--number-sections` is specified. A single hyphen (`-`) in an attribute
936context is equivalent to `.unnumbered`, and preferable in non-English
943 # My header {.unnumbered}
945**Extension: `auto_identifiers`**
947A header without an explicitly specified identifier will be
948automatically assigned a unique identifier based on the header text.
949To derive the identifier from the header text,
951 - Remove all formatting, links, etc.
952 - Remove all footnotes.
953 - Remove all punctuation, except underscores, hyphens, and periods.
954 - Replace all spaces and newlines with hyphens.
955 - Convert all alphabetic characters to lowercase.
956 - Remove everything up to the first letter (identifiers may
957 not begin with a number or punctuation mark).
958 - If nothing is left after this, use the identifier `section`.
963 ------------------------------- ----------------------------
964 Header identifiers in HTML `header-identifiers-in-html`
965 *Dogs*?--in *my* house? `dogs--in-my-house`
966 [HTML], [S5], or [RTF]? `html-s5-or-rtf`
967 3. Applications `applications`
970These rules should, in most cases, allow one to determine the identifier
971from the header text. The exception is when several headers have the
972same text; in this case, the first will get an identifier as described
973above; the second will get the same identifier with `-1` appended; the
974third with `-2`; and so on.
976These identifiers are used to provide link targets in the table of
977contents generated by the `--toc|--table-of-contents` option. They
978also make it easy to provide links from one section of a document to
979another. A link to this section, for example, might look like this:
982 [header identifiers](#header-identifiers-in-html-latex-and-context).
984Note, however, that this method of providing links to sections works
985only in HTML, LaTeX, and ConTeXt formats.
987If the `--section-divs` option is specified, then each section will
988be wrapped in a `div` (or a `section`, if `--html5` was specified),
989and the identifier will be attached to the enclosing `<div>`
990(or `<section>`) tag rather than the header itself. This allows entire
991sections to be manipulated using javascript or treated differently in
994**Extension: `implicit_header_references`**
996Pandoc behaves as if reference links have been defined for each header.
999 [header identifiers](#header-identifiers-in-html)
1003 [header identifiers]
1007 [header identifiers][]
1011 [the section on header identifiers][header identifiers]
1013If there are multiple headers with identical text, the corresponding
1014reference will link to the first one only, and you will need to use explicit
1015links to link to the others, as described above.
1017Unlike regular reference links, these references are case-sensitive.
1019Note: if you have defined an explicit identifier for a header,
1020then implicit references to it will not work.
1025Markdown uses email conventions for quoting blocks of text.
1026A block quotation is one or more paragraphs or other block elements
1027(such as lists or headers), with each line preceded by a `>` character
1028and a space. (The `>` need not start at the left margin, but it should
1029not be indented more than three spaces.)
1031 > This is a block quote. This
1032 > paragraph has two lines.
1034 > 1. This is a list inside a block quote.
1037A "lazy" form, which requires the `>` character only on the first
1038line of each block, is also allowed:
1040 > This is a block quote. This
1041 paragraph has two lines.
1043 > 1. This is a list inside a block quote.
1046Among the block elements that can be contained in a block quote are
1047other block quotes. That is, block quotes can be nested:
1049 > This is a block quote.
1051 > > A block quote within a block quote.
1053**Extension: `blank_before_blockquote`**
1055Standard markdown syntax does not require a blank line before a block
1056quote. Pandoc does require this (except, of course, at the beginning of the
1057document). The reason for the requirement is that it is all too easy for a
1058`>` to end up at the beginning of a line by accident (perhaps through line
1059wrapping). So, unless the `markdown_strict` format is used, the following does
1060not produce a nested block quote in pandoc:
1062 > This is a block quote.
1066Verbatim (code) blocks
1067----------------------
1069### Indented code blocks ###
1071A block of text indented four spaces (or one tab) is treated as verbatim
1072text: that is, special characters do not trigger special formatting,
1073and all spaces and line breaks are preserved. For example,
1076 moveShip(5 * gravity, DOWN);
1079The initial (four space or one tab) indentation is not considered part
1080of the verbatim text, and is removed in the output.
1082Note: blank lines in the verbatim text need not begin with four spaces.
1085### Fenced code blocks ###
1087**Extension: `fenced_code_blocks`**
1089In addition to standard indented code blocks, Pandoc supports
1090*fenced* code blocks. These begin with a row of three or more
1091tildes (`~`) or backticks (`` ` ``) and end with a row of tildes or
1092backticks that must be at least as long as the starting row. Everything
1093between these lines is treated as code. No indentation is necessary:
1097 moveShip(5 * gravity, DOWN);
1101Like regular code blocks, fenced code blocks must be separated
1102from surrounding text by blank lines.
1104If the code itself contains a row of tildes or backticks, just use a longer
1105row of tildes or backticks at the start and end:
1109 code including tildes
1113Optionally, you may attach attributes to the code block using
1116 ~~~~ {#mycode .haskell .numberLines startFrom="100"}
1118 qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
1119 qsort (filter (>= x) xs)
1120 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1122Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and
1123`startFrom` is an attribute with value `100`. Some output formats can use this
1124information to do syntax highlighting. Currently, the only output formats
1125that uses this information are HTML and LaTeX. If highlighting is supported
1126for your output format and language, then the code block above will appear
1127highlighted, with numbered lines. (To see which languages are supported, do
1128`pandoc --version`.) Otherwise, the code block above will appear as follows:
1130 <pre id="mycode" class="haskell numberLines" startFrom="100">
1136A shortcut form can also be used for specifying the language of
1143This is equivalent to:
1149To prevent all highlighting, use the `--no-highlight` flag.
1150To set the highlighting style, use `--highlight-style`.
1155**Extension: `line_blocks`**
1157A line block is a sequence of lines beginning with a vertical bar (`|`)
1158followed by a space. The division into lines will be preserved in
1159the output, as will any leading spaces; otherwise, the lines will
1160be formatted as markdown. This is useful for verse and addresses:
1162 | The limerick packs laughs anatomical
1163 | In space that is quite economical.
1164 | But the good ones I've seen
1165 | So seldom are clean
1166 | And the clean ones so seldom are comical
1169 | Berkeley, CA 94718
1171The lines can be hard-wrapped if needed, but the continuation
1172line must begin with a space.
1174 | The Right Honorable Most Venerable and Righteous Samuel L.
1177 | Berkeley, CA 94718
1179This syntax is borrowed from [reStructuredText].
1186A bullet list is a list of bulleted list items. A bulleted list
1187item begins with a bullet (`*`, `+`, or `-`). Here is a simple
1194This will produce a "compact" list. If you want a "loose" list, in which
1195each item is formatted as a paragraph, put spaces between the items:
1203The bullets need not be flush with the left margin; they may be
1204indented one, two, or three spaces. The bullet must be followed
1207List items look best if subsequent lines are flush with the first
1208line (after the bullet):
1214But markdown also allows a "lazy" format:
1220### The four-space rule ###
1222A list item may contain multiple paragraphs and other block-level
1223content. However, subsequent paragraphs must be preceded by a blank line
1224and indented four spaces or a tab. The list will look better if the first
1225paragraph is aligned with the rest:
1231 * Second paragraph. With a code block, which must be indented
1236List items may include other lists. In this case the preceding blank
1237line is optional. The nested list must be indented four spaces or
1250As noted above, markdown allows you to write list items "lazily," instead of
1251indenting continuation lines. However, if there are multiple paragraphs or
1252other blocks in a list item, the first line of each must be indented.
1254 + A lazy, lazy, list
1257 + Another one; this looks
1260 Second paragraph of second
1263**Note:** Although the four-space rule for continuation paragraphs
1264comes from the official [markdown syntax guide], the reference implementation,
1265`Markdown.pl`, does not follow it. So pandoc will give different results than
1266`Markdown.pl` when authors have indented continuation paragraphs fewer than
1269The [markdown syntax guide] is not explicit whether the four-space
1270rule applies to *all* block-level content in a list item; it only
1271mentions paragraphs and code blocks. But it implies that the rule
1272applies to all block-level content (including nested lists), and
1273pandoc interprets it that way.
1275 [markdown syntax guide]:
1276 http://daringfireball.net/projects/markdown/syntax#list
1278### Ordered lists ###
1280Ordered lists work just like bulleted lists, except that the items
1281begin with enumerators rather than bullets.
1283In standard markdown, enumerators are decimal numbers followed
1284by a period and a space. The numbers themselves are ignored, so
1285there is no difference between this list:
1297**Extension: `fancy_lists`**
1299Unlike standard markdown, Pandoc allows ordered list items to be marked
1300with uppercase and lowercase letters and roman numerals, in addition to
1301arabic numerals. List markers may be enclosed in parentheses or followed by a
1302single right-parentheses or period. They must be separated from the
1303text that follows by at least one space, and, if the list marker is a
1304capital letter with a period, by at least two spaces.[^2]
1306[^2]: The point of this rule is to ensure that normal paragraphs
1307 starting with people's initials, like
1309 B. Russell was an English philosopher.
1311 do not get treated as list items.
1313 This rule will not prevent
1317 from being interpreted as a list item. In this case, a backslash
1322The `fancy_lists` extension also allows '`#`' to be used as an
1323ordered list marker in place of a numeral:
1328**Extension: `startnum`**
1330Pandoc also pays attention to the type of list marker used, and to the
1331starting number, and both of these are preserved where possible in the
1332output format. Thus, the following yields a list with numbers followed
1333by a single parenthesis, starting with 9, and a sublist with lowercase
1343Pandoc will start a new list each time a different type of list
1344marker is used. So, the following will create three lists:
1351If default list markers are desired, use `#.`:
1358### Definition lists ###
1360**Extension: `definition_lists`**
1362Pandoc supports definition lists, using a syntax inspired by
1363[PHP Markdown Extra] and [reStructuredText]:[^3]
1369 Term 2 with *inline markup*
1373 { some code, part of Definition 2 }
1375 Third paragraph of definition 2.
1377Each term must fit on one line, which may optionally be followed by
1378a blank line, and must be followed by one or more definitions.
1379A definition begins with a colon or tilde, which may be indented one
1380or two spaces. The body of the definition (including the first line,
1381aside from the colon or tilde) should be indented four spaces. A term may have
1382multiple definitions, and each definition may consist of one or more block
1383elements (paragraph, code block, list, etc.), each indented four spaces or one
1386If you leave space after the definition (as in the example above),
1387the blocks of the definitions will be considered paragraphs. In some
1388output formats, this will mean greater spacing between term/definition
1389pairs. For a compact definition list, do not leave space between the
1390definition and the next term:
1398[^3]: I have also been influenced by the suggestions of [David Wheeler](http://www.justatheory.com/computers/markup/modest-markdown-proposal.html).
1400[PHP Markdown Extra]: http://www.michelf.com/projects/php-markdown/extra/
1403### Numbered example lists ###
1405**Extension: `example_lists`**
1407The special list marker `@` can be used for sequentially numbered
1408examples. The first list item with a `@` marker will be numbered '1',
1409the next '2', and so on, throughout the document. The numbered examples
1410need not occur in a single list; each new list using `@` will take up
1411where the last stopped. So, for example:
1413 (@) My first example will be numbered (1).
1414 (@) My second example will be numbered (2).
1416 Explanation of examples.
1418 (@) My third example will be numbered (3).
1420Numbered examples can be labeled and referred to elsewhere in the
1423 (@good) This is a good example.
1425 As (@good) illustrates, ...
1427The label can be any string of alphanumeric characters, underscores,
1431### Compact and loose lists ###
1433Pandoc behaves differently from `Markdown.pl` on some "edge
1434cases" involving lists. Consider this source:
1444Pandoc transforms this into a "compact list" (with no `<p>` tags around
1445"First", "Second", or "Third"), while markdown puts `<p>` tags around
1446"Second" and "Third" (but not "First"), because of the blank space
1447around "Third". Pandoc follows a simple rule: if the text is followed by
1448a blank line, it is treated as a paragraph. Since "Second" is followed
1449by a list, and not a blank line, it isn't treated as a paragraph. The
1450fact that the list is followed by a blank line is irrelevant. (Note:
1451Pandoc works this way even when the `markdown_strict` format is specified. This
1452behavior is consistent with the official markdown syntax description,
1453even though it is different from that of `Markdown.pl`.)
1456### Ending a list ###
1458What if you want to put an indented code block after a list?
1465Trouble! Here pandoc (like other markdown implementations) will treat
1466`{ my code block }` as the second paragraph of item two, and not as
1469To "cut off" the list after item two, you can insert some non-indented
1470content, like an HTML comment, which won't produce visible output in
1476 <!-- end of list -->
1480You can use the same trick if you want two consecutive lists instead
1496A line containing a row of three or more `*`, `-`, or `_` characters
1497(optionally separated by spaces) produces a horizontal rule:
1507Four kinds of tables may be used. The first three kinds presuppose the use of
1508a fixed-width font, such as Courier. The fourth kind can be used with
1509proportionally spaced fonts, as it does not require lining up columns.
1513**Extension: `simple_tables`, `table_captions`**
1515Simple tables look like this:
1517 Right Left Center Default
1518 ------- ------ ---------- -------
1523 Table: Demonstration of simple table syntax.
1525The headers and table rows must each fit on one line. Column
1526alignments are determined by the position of the header text relative
1527to the dashed line below it:[^4]
1529 - If the dashed line is flush with the header text on the right side
1530 but extends beyond it on the left, the column is right-aligned.
1531 - If the dashed line is flush with the header text on the left side
1532 but extends beyond it on the right, the column is left-aligned.
1533 - If the dashed line extends beyond the header text on both sides,
1534 the column is centered.
1535 - If the dashed line is flush with the header text on both sides,
1536 the default alignment is used (in most cases, this will be left).
1538[^4]: This scheme is due to Michel Fortin, who proposed it on the
1539 [Markdown discussion list](http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html).
1541The table must end with a blank line, or a line of dashes followed by
1542a blank line. A caption may optionally be provided (as illustrated in
1543the example above). A caption is a paragraph beginning with the string
1544`Table:` (or just `:`), which will be stripped off. It may appear either
1545before or after the table.
1547The column headers may be omitted, provided a dashed line is used
1548to end the table. For example:
1550 ------- ------ ---------- -------
1554 ------- ------ ---------- -------
1556When headers are omitted, column alignments are determined on the basis
1557of the first line of the table body. So, in the tables above, the columns
1558would be right, left, center, and right aligned, respectively.
1562**Extension: `multiline_tables`, `table_captions`**
1564Multiline tables allow headers and table rows to span multiple lines
1565of text (but cells that span multiple columns or rows of the table are
1566not supported). Here is an example:
1568 -------------------------------------------------------------
1569 Centered Default Right Left
1570 Header Aligned Aligned Aligned
1571 ----------- ------- --------------- -------------------------
1572 First row 12.0 Example of a row that
1573 spans multiple lines.
1575 Second row 5.0 Here's another one. Note
1576 the blank line between
1578 -------------------------------------------------------------
1580 Table: Here's the caption. It, too, may span
1583These work like simple tables, but with the following differences:
1585 - They must begin with a row of dashes, before the header text
1586 (unless the headers are omitted).
1587 - They must end with a row of dashes, then a blank line.
1588 - The rows must be separated by blank lines.
1590In multiline tables, the table parser pays attention to the widths of
1591the columns, and the writers try to reproduce these relative widths in
1592the output. So, if you find that one of the columns is too narrow in the
1593output, try widening it in the markdown source.
1595Headers may be omitted in multiline tables as well as simple tables:
1597 ----------- ------- --------------- -------------------------
1598 First row 12.0 Example of a row that
1599 spans multiple lines.
1601 Second row 5.0 Here's another one. Note
1602 the blank line between
1604 ----------- ------- --------------- -------------------------
1606 : Here's a multiline table without headers.
1608It is possible for a multiline table to have just one row, but the row
1609should be followed by a blank line (and then the row of dashes that ends
1610the table), or the table may be interpreted as a simple table.
1614**Extension: `grid_tables`, `table_captions`**
1616Grid tables look like this:
1618 : Sample grid table.
1620 +---------------+---------------+--------------------+
1621 | Fruit | Price | Advantages |
1622 +===============+===============+====================+
1623 | Bananas | $1.34 | - built-in wrapper |
1624 | | | - bright color |
1625 +---------------+---------------+--------------------+
1626 | Oranges | $2.10 | - cures scurvy |
1628 +---------------+---------------+--------------------+
1630The row of `=`s separates the header from the table body, and can be
1631omitted for a headerless table. The cells of grid tables may contain
1632arbitrary block elements (multiple paragraphs, code blocks, lists,
1633etc.). Alignments are not supported, nor are cells that span multiple
1634columns or rows. Grid tables can be created easily using [Emacs table mode].
1636 [Emacs table mode]: http://table.sourceforge.net/
1640**Extension: `pipe_tables`, `table_captions`**
1642Pipe tables look like this:
1644 | Right | Left | Default | Center |
1645 |------:|:-----|---------|:------:|
1646 | 12 | 12 | 12 | 12 |
1647 | 123 | 123 | 123 | 123 |
1650 : Demonstration of simple table syntax.
1652The syntax is [the same as in PHP markdown extra]. The beginning and
1653ending pipe characters are optional, but pipes are required between all
1654columns. The colons indicate column alignment as shown. The header
1655can be omitted, but the horizontal line must still be included, as
1656it defines column alignments.
1658Since the pipes indicate column boundaries, columns need not be vertically
1659aligned, as they are in the above example. So, this is a perfectly
1660legal (though ugly) pipe table:
1668The cells of pipe tables cannot contain block elements like paragraphs
1669and lists, and cannot span multiple lines.
1671 [the same as in PHP markdown extra]:
1672 http://michelf.ca/projects/php-markdown/extra/#table
1674Note: Pandoc also recognizes pipe tables of the following
1675form, as can produced by Emacs' orgtbl-mode:
1682The difference is that `+` is used instead of `|`. Other orgtbl features
1683are not supported. In particular, to get non-default column alignment,
1684you'll need to add colons as above.
1689**Extension: `pandoc_title_block`**
1691If the file begins with a title block
1694 % author(s) (separated by semicolons)
1697it will be parsed as bibliographic information, not regular text. (It
1698will be used, for example, in the title of standalone LaTeX or HTML
1699output.) The block may contain just a title, a title and an author,
1700or all three elements. If you want to include an author but no
1701title, or a title and a date but no author, you need a blank line:
1710The title may occupy multiple lines, but continuation lines must
1711begin with leading space, thus:
1716If a document has multiple authors, the authors may be put on
1717separate lines with leading space, or separated by semicolons, or
1718both. So, all of the following are equivalent:
1723 % Author One; Author Two
1728The date must fit on one line.
1730All three metadata fields may contain standard inline formatting
1731(italics, links, footnotes, etc.).
1733Title blocks will always be parsed, but they will affect the output only
1734when the `--standalone` (`-s`) option is chosen. In HTML output, titles
1735will appear twice: once in the document head -- this is the title that
1736will appear at the top of the window in a browser -- and once at the
1737beginning of the document body. The title in the document head can have
1738an optional prefix attached (`--title-prefix` or `-T` option). The title
1739in the body appears as an H1 element with class "title", so it can be
1740suppressed or reformatted with CSS. If a title prefix is specified with
1741`-T` and no title block appears in the document, the title prefix will
1742be used by itself as the HTML title.
1744The man page writer extracts a title, man page section number, and
1745other header and footer information from the title line. The title
1746is assumed to be the first word on the title line, which may optionally
1747end with a (single-digit) section number in parentheses. (There should
1748be no space between the title and the parentheses.) Anything after
1749this is assumed to be additional footer and header text. A single pipe
1750character (`|`) should be used to separate the footer text from the header
1755will yield a man page with the title `PANDOC` and section 1.
1757 % PANDOC(1) Pandoc User Manuals
1759will also have "Pandoc User Manuals" in the footer.
1761 % PANDOC(1) Pandoc User Manuals | Version 4.0
1763will also have "Version 4.0" in the header.
1768**Extension: `yaml_metadata_block`**
1770A YAML metadata block is a valid YAML object, delimited by a line of three
1771hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
1772(`...`) at the bottom. A YAML metadata block may occur anywhere in the
1773document, but if it is not at the beginning, it must be preceded by a blank
1776Metadata will be taken from the fields of the YAML object and added to any
1777existing document metadata. Metadata can contain lists and objects (nested
1778arbitrarily), but all string scalars will be interpreted as markdown. Fields
1779with names ending in an underscore will be ignored by pandoc. (They may be
1780given a role by external processors.)
1782A document may contain multiple metadata blocks. The metadata fields will
1783be combined through a *left-biased union*: if two metadata blocks attempt
1784to set the same field, the value from the first block will be taken.
1786Note that YAML escaping rules must be followed. Thus, for example,
1787if a title contains a colon, it must be quoted. The pipe character
1788(`|`) can be used to begin an indented block that will be interpreted
1789literally, without need for escaping. This form is necessary
1790when the field contains blank lines:
1793 title: 'This is the title: it contains a colon'
1796 affiliation: University of Somewhere
1798 affiliation: University of Nowhere
1799 tags: [nothing, nothingness]
1801 This is the abstract.
1803 It consists of two paragraphs.
1806Template variables will be set automatically from the metadata. Thus, for
1807example, in writing HTML, the variable `abstract` will be set to the HTML
1808equivalent of the markdown in the `abstract` field:
1810 <p>This is the abstract.</p>
1811 <p>It consists of two paragraphs.</p>
1817**Extension: `all_symbols_escapable`**
1819Except inside a code block or inline code, any punctuation or space
1820character preceded by a backslash will be treated literally, even if it
1821would normally indicate formatting. Thus, for example, if one writes
1831 <strong>hello</strong>
1833This rule is easier to remember than standard markdown's rule,
1834which allows only the following characters to be backslash-escaped:
1838(However, if the `markdown_strict` format is used, the standard markdown rule
1841A backslash-escaped space is parsed as a nonbreaking space. It will
1842appear in TeX output as `~` and in HTML and XML as `\ ` or
1845A backslash-escaped newline (i.e. a backslash occurring at the end of
1846a line) is parsed as a hard line break. It will appear in TeX output as
1847`\\` and in HTML as `<br />`. This is a nice alternative to
1848markdown's "invisible" way of indicating hard line breaks using
1849two trailing spaces on a line.
1851Backslash escapes do not work in verbatim contexts.
1858If the `--smart` option is specified, pandoc will produce typographically
1859correct output, converting straight quotes to curly quotes, `---` to
1860em-dashes, `--` to en-dashes, and `...` to ellipses. Nonbreaking spaces
1861are inserted after certain abbreviations, such as "Mr."
1863Note: if your LaTeX template uses the `csquotes` package, pandoc will
1864detect automatically this and use `\enquote{...}` for quoted text.
1871To *emphasize* some text, surround it with `*`s or `_`, like this:
1873 This text is _emphasized with underscores_, and this
1874 is *emphasized with asterisks*.
1876Double `*` or `_` produces **strong emphasis**:
1878 This is **strong emphasis** and __with underscores__.
1880A `*` or `_` character surrounded by spaces, or backslash-escaped,
1881will not trigger emphasis:
1883 This is * not emphasized *, and \*neither is this\*.
1885**Extension: `intraword_underscores`**
1887Because `_` is sometimes used inside words and identifiers,
1888pandoc does not interpret a `_` surrounded by alphanumeric
1889characters as an emphasis marker. If you want to emphasize
1890just part of a word, use `*`:
1892 feas*ible*, not feas*able*.
1897**Extension: `strikeout`**
1899To strikeout a section of text with a horizontal line, begin and end it
1900with `~~`. Thus, for example,
1902 This ~~is deleted text.~~
1905### Superscripts and subscripts ###
1907**Extension: `superscript`, `subscript`**
1909Superscripts may be written by surrounding the superscripted text by `^`
1910characters; subscripts may be written by surrounding the subscripted
1911text by `~` characters. Thus, for example,
1913 H~2~O is a liquid. 2^10^ is 1024.
1915If the superscripted or subscripted text contains spaces, these spaces
1916must be escaped with backslashes. (This is to prevent accidental
1917superscripting and subscripting through the ordinary use of `~` and `^`.)
1918Thus, if you want the letter P with 'a cat' in subscripts, use
1919`P~a\ cat~`, not `P~a cat~`.
1924To make a short span of text verbatim, put it inside backticks:
1926 What is the difference between `>>=` and `>>`?
1928If the verbatim text includes a backtick, use double backticks:
1930 Here is a literal backtick `` ` ``.
1932(The spaces after the opening backticks and before the closing
1933backticks will be ignored.)
1935The general rule is that a verbatim span starts with a string
1936of consecutive backticks (optionally followed by a space)
1937and ends with a string of the same number of backticks (optionally
1938preceded by a space).
1940Note that backslash-escapes (and other markdown constructs) do not
1941work in verbatim contexts:
1943 This is a backslash followed by an asterisk: `\*`.
1945**Extension: `inline_code_attributes`**
1947Attributes can be attached to verbatim text, just as with
1948[fenced code blocks](#fenced-code-blocks):
1955**Extension: `tex_math_dollars`**
1957Anything between two `$` characters will be treated as TeX math. The
1958opening `$` must have a character immediately to its right, while the
1959closing `$` must have a character immediately to its left. Thus,
1960`$20,000 and $30,000` won't parse as math. If for some reason
1961you need to enclose text in literal `$` characters, backslash-escape
1962them and they won't be treated as math delimiters.
1964TeX math will be printed in all output formats. How it is rendered
1965depends on the output format:
1967Markdown, LaTeX, Org-Mode, ConTeXt
1968 ~ It will appear verbatim between `$` characters.
1971 ~ It will be rendered using an interpreted text role `:math:`, as described
1972 [here](http://www.american.edu/econ/itex2mml/mathhack.rst).
1975 ~ It will be rendered as `latexmath:[...]`.
1978 ~ It will be rendered inside a `@math` command.
1981 ~ It will be rendered verbatim without `$`'s.
1984 ~ It will be rendered inside `<math>` tags.
1987 ~ It will be rendered inside `<span class="math">` tags.
1989RTF, OpenDocument, ODT
1990 ~ It will be rendered, if possible, using unicode characters,
1991 and will otherwise appear verbatim.
1994 ~ If the `--mathml` flag is used, it will be rendered using mathml
1995 in an `inlineequation` or `informalequation` tag. Otherwise it
1996 will be rendered, if possible, using unicode characters.
1999 ~ It will be rendered using OMML math markup.
2002 ~ If the `--webtex` option is used, formulas are rendered as images
2003 using Google Charts or other compatible web service, downloaded
2004 and embedded in the e-book. Otherwise, they will appear verbatim.
2006HTML, Slidy, DZSlides, S5, EPUB
2007 ~ The way math is rendered in HTML will depend on the
2008 command-line options selected:
2010 1. The default is to render TeX math as far as possible using unicode
2011 characters, as with RTF, DocBook, and OpenDocument output. Formulas
2012 are put inside a `span` with `class="math"`, so that they may be
2013 styled differently from the surrounding text if needed.
2015 2. If the `--latexmathml` option is used, TeX math will be displayed
2016 between `$` or `$$` characters and put in `<span>` tags with class `LaTeX`.
2017 The [LaTeXMathML] script will be used to render it as formulas.
2018 (This trick does not work in all browsers, but it works in Firefox.
2019 In browsers that do not support LaTeXMathML, TeX math will appear
2020 verbatim between `$` characters.)
2022 3. If the `--jsmath` option is used, TeX math will be put inside
2023 `<span>` tags (for inline math) or `<div>` tags (for display math)
2024 with class `math`. The [jsMath] script will be used to render
2027 4. If the `--mimetex` option is used, the [mimeTeX] CGI script will
2028 be called to generate images for each TeX formula. This should
2029 work in all browsers. The `--mimetex` option takes an optional URL
2030 as argument. If no URL is specified, it will be assumed that the
2031 mimeTeX CGI script is at `/cgi-bin/mimetex.cgi`.
2033 5. If the `--gladtex` option is used, TeX formulas will be enclosed
2034 in `<eq>` tags in the HTML output. The resulting `htex` file may then
2035 be processed by [gladTeX], which will produce image files for each
2036 formula and an `html` file with links to these images. So, the
2039 pandoc -s --gladtex myfile.txt -o myfile.htex
2040 gladtex -d myfile-images myfile.htex
2041 # produces myfile.html and images in myfile-images
2043 6. If the `--webtex` option is used, TeX formulas will be converted
2044 to `<img>` tags that link to an external script that converts
2045 formulas to images. The formula will be URL-encoded and concatenated
2046 with the URL provided. If no URL is specified, the Google Chart
2047 API will be used (`http://chart.apis.google.com/chart?cht=tx&chl=`).
2049 7. If the `--mathjax` option is used, TeX math will be displayed
2050 between `\(...\)` (for inline math) or `\[...\]` (for display
2051 math) and put in `<span>` tags with class `math`.
2052 The [MathJax] script will be used to render it as formulas.
2057**Extension: `raw_html`**
2059Markdown allows you to insert raw HTML (or DocBook) anywhere in a document
2060(except verbatim contexts, where `<`, `>`, and `&` are interpreted
2061literally). (Techncially this is not an extension, since standard
2062markdown allows it, but it has been made an extension so that it can
2063be disabled if desired.)
2065The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
2066DZSlides, EPUB, Markdown, and Textile output, and suppressed in other
2069**Extension: `markdown_in_html_blocks`**
2071Standard markdown allows you to include HTML "blocks": blocks
2072of HTML between balanced tags that are separated from the surrounding text
2073with blank lines, and start and end at the left margin. Within
2074these blocks, everything is interpreted as HTML, not markdown;
2075so (for example), `*` does not signify emphasis.
2077Pandoc behaves this way when the `markdown_strict` format is used; but
2078by default, pandoc interprets material between HTML block tags as markdown.
2079Thus, for example, Pandoc will turn
2084 <td>[a link](http://google.com)</td>
2092 <td><em>one</em></td>
2093 <td><a href="http://google.com">a link</a></td>
2097whereas `Markdown.pl` will preserve it as is.
2099There is one exception to this rule: text between `<script>` and
2100`<style>` tags is not interpreted as markdown.
2102This departure from standard markdown should make it easier to mix
2103markdown with HTML block elements. For example, one can surround
2104a block of markdown text with `<div>` tags without preventing it
2105from being interpreted as markdown.
2110**Extension: `raw_tex`**
2112In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be
2113included in a document. Inline TeX commands will be preserved and passed
2114unchanged to the LaTeX and ConTeXt writers. Thus, for example, you can use
2115LaTeX to include BibTeX citations:
2117 This result was proved in \cite{jones.1967}.
2119Note that in LaTeX environments, like
2121 \begin{tabular}{|l|l|}\hline
2122 Age & Frequency \\ \hline
2125 36--45 & 22 \\ \hline
2128the material between the begin and end tags will be interpreted as raw
2129LaTeX, not as markdown.
2131Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
2137**Extension: `latex_macros`**
2139For output formats other than LaTeX, pandoc will parse LaTeX `\newcommand` and
2140`\renewcommand` definitions and apply the resulting macros to all LaTeX
2141math. So, for example, the following will work in all output formats,
2144 \newcommand{\tuple}[1]{\langle #1 \rangle}
2148In LaTeX output, the `\newcommand` definition will simply be passed
2149unchanged to the output.
2155Markdown allows links to be specified in several ways.
2157### Automatic links ###
2159If you enclose a URL or email address in pointy brackets, it
2163 <sam@green.eggs.ham>
2167An inline link consists of the link text in square brackets,
2168followed by the URL in parentheses. (Optionally, the URL can
2169be followed by a link title, in quotes.)
2171 This is an [inline link](/url), and here's [one with
2172 a title](http://fsf.org "click here for a good time!").
2174There can be no space between the bracketed part and the parenthesized part.
2175The link text can contain formatting (such as emphasis), but the title cannot.
2178### Reference links ###
2180An *explicit* reference link has two parts, the link itself and the link
2181definition, which may occur elsewhere in the document (either
2182before or after the link).
2184The link consists of link text in square brackets, followed by a label in
2185square brackets. (There can be space between the two.) The link definition
2186consists of the bracketed label, followed by a colon and a space, followed by
2187the URL, and optionally (after a space) a link title either in quotes or in
2190Here are some examples:
2192 [my label 1]: /foo/bar.html "My title, optional"
2194 [my label 3]: http://fsf.org (The free software foundation)
2195 [my label 4]: /bar#special 'A title in single quotes'
2197The URL may optionally be surrounded by angle brackets:
2199 [my label 5]: <http://foo.bar.baz>
2201The title may go on the next line:
2203 [my label 3]: http://fsf.org
2204 "The free software foundation"
2206Note that link labels are not case sensitive. So, this will work:
2208 Here is [my link][FOO]
2212In an *implicit* reference link, the second pair of brackets is
2213empty, or omitted entirely:
2215 See [my website][], or [my website].
2217 [my website]: http://foo.bar.baz
2219Note: In `Markdown.pl` and most other markdown implementations,
2220reference link definitions cannot occur in nested constructions
2221such as list items or block quotes. Pandoc lifts this arbitrary
2222seeming restriction. So the following is fine in pandoc, though
2223not in most other implementations:
2231To link to another section of the same document, use the automatically
2232generated identifier (see [Header identifiers in HTML, LaTeX, and
2233ConTeXt](#header-identifiers-in-html-latex-and-context), below).
2236 See the [Introduction](#introduction).
2240 See the [Introduction].
2242 [Introduction]: #introduction
2244Internal links are currently supported for HTML formats (including
2245HTML slide shows and EPUB), LaTeX, and ConTeXt.
2250A link immediately preceded by a `!` will be treated as an image.
2251The link text will be used as the image's alt text:
2253 
2257 [movie reel]: movie.gif
2259### Pictures with captions ###
2261**Extension: `implicit_figures`**
2263An image occurring by itself in a paragraph will be rendered as
2264a figure with a caption.[^5] (In LaTeX, a figure environment will be
2265used; in HTML, the image will be placed in a `div` with class
2266`figure`, together with a caption in a `p` with class `caption`.)
2267The image's alt text will be used as the caption.
2269 
2271[^5]: This feature is not yet implemented for RTF, OpenDocument, or
2272 ODT. In those formats, you'll just get an image in a paragraph by
2273 itself, with no caption.
2275If you just want a regular inline image, just make sure it is not
2276the only thing in the paragraph. One way to do this is to insert a
2277nonbreaking space after the image:
2279 \
2285**Extension: `footnotes`**
2287Pandoc's markdown allows footnotes, using the following syntax:
2289 Here is a footnote reference,[^1] and another.[^longnote]
2291 [^1]: Here is the footnote.
2293 [^longnote]: Here's one with multiple blocks.
2295 Subsequent paragraphs are indented to show that they
2296 belong to the previous footnote.
2300 The whole paragraph can be indented, or just the first
2301 line. In this way, multi-paragraph footnotes work like
2302 multi-paragraph list items.
2304 This paragraph won't be part of the note, because it
2307The identifiers in footnote references may not contain spaces, tabs,
2308or newlines. These identifiers are used only to correlate the
2309footnote reference with the note itself; in the output, footnotes
2310will be numbered sequentially.
2312The footnotes themselves need not be placed at the end of the
2313document. They may appear anywhere except inside other block elements
2314(lists, block quotes, tables, etc.).
2316**Extension: `inline_notes`**
2318Inline footnotes are also allowed (though, unlike regular notes,
2319they cannot contain multiple paragraphs). The syntax is as follows:
2321 Here is an inline note.^[Inlines notes are easier to write, since
2322 you don't have to pick an identifier and move down to type the
2325Inline and regular footnotes may be mixed freely.
2331**Extension: `citations`**
2333Using an external filter, `pandoc-citeproc`, pandoc can automatically generate
2334citations and a bibliography in a number of styles. Basic usage is
2336 pandoc --filter pandoc-citeproc myinput.txt
2338In order to use this feature, you will need to specify a bibliography file
2339using the `bibliography` metadata field in a YAML metadata section.
2340The bibliography may have any of these formats:
2342 Format File extension
2343 ------------ --------------
2355Note that `.bib` can generally be used with both BibTeX and BibLaTeX
2356files, but you can use `.bibtex` to force BibTeX.
2358Alternatively you can use a `references` field in the document's YAML
2359metadata. This should include an array of YAML-encoded references,
2365 title: One-click science marketing
2369 container-title: Nature Materials
2371 URL: 'http://dx.doi.org/10.1038/nmat3283'
2372 DOI: 10.1038/nmat3283
2374 publisher: Nature Publishing Group
2376 type: article-journal
2382(The program `mods2yaml`, which comes with `pandoc-citeproc`, can help produce
2383these from a MODS reference collection.)
2385By default, `pandoc-citeproc` will use a Chicago author-date format for
2386citations and references. To use another style, you will need to specify
2387a [CSL] 1.0 style file in the `csl` metadata field. A primer on creating and
2388modifying CSL styles can be found at
2389<http://citationstyles.org/downloads/primer.html>. A repository of CSL styles
2390can be found at <https://github.com/citation-style-language/styles>. See also
2391<http://zotero.org/styles> for easy browsing.
2393Citations go inside square brackets and are separated by semicolons.
2394Each citation must have a key, composed of '@' + the citation
2395identifier from the database, and may optionally have a prefix,
2396a locator, and a suffix. Here are some examples:
2398 Blah blah [see @doe99, pp. 33-35; also @smith04, ch. 1].
2400 Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
2402 Blah blah [@smith04; @doe99].
2404A minus sign (`-`) before the `@` will suppress mention of
2405the author in the citation. This can be useful when the
2406author is already mentioned in the text:
2408 Smith says blah [-@smith04].
2410You can also write an in-text citation, as follows:
2414 @smith04 [p. 33] says blah.
2416If the style calls for a list of works cited, it will be placed
2417at the end of the document. Normally, you will want to end your
2418document with an appropriate header:
2424The bibliography will be inserted after this header.
2426Non-pandoc extensions
2427---------------------
2429The following markdown syntax extensions are not enabled by default
2430in pandoc, but may be enabled by adding `+EXTENSION` to the format
2431name, where `EXTENSION` is the name of the extension. Thus, for
2432example, `markdown+hard_line_breaks` is markdown with hard line breaks.
2434**Extension: `hard_line_breaks`**\
2435Causes all newlines within a paragraph to be interpreted as hard line
2436breaks instead of spaces.
2438**Extension: `ignore_line_breaks`**\
2439Causes newlines within a paragraph to be ignored, rather than being
2440treated as spaces or as hard line breaks. This option is intended for
2441use with East Asian languages where spaces are not used between words,
2442but text is divided into lines for readability.
2444**Extension: `tex_math_single_backslash`**\
2445Causes anything between `\(` and `\)` to be interpreted as inline
2446TeX math, and anything between `\[` and `\]` to be interpreted
2447as display TeX math. Note: a drawback of this extension is that
2448it precludes escaping `(` and `[`.
2450**Extension: `tex_math_double_backslash`**\
2451Causes anything between `\\(` and `\\)` to be interpreted as inline
2452TeX math, and anything between `\\[` and `\\]` to be interpreted
2455**Extension: `markdown_attribute`**\
2456By default, pandoc interprets material inside block-level tags as markdown.
2457This extension changes the behavior so that markdown is only parsed
2458inside block-level tags if the tags have the attribute `markdown=1`.
2460**Extension: `mmd_title_block`**\
2461Enables a [MultiMarkdown] style title block at the top of
2462the document, for example:
2466 Date: September 1, 2008
2467 Comment: This is a sample mmd title block, with
2468 a field spanning multiple lines.
2470See the MultiMarkdown documentation for details. Note that only title,
2471author, and date are recognized; other fields are simply ignored by
2472pandoc. If `pandoc_title_block` or `yaml_metadata_block` is enabled,
2473it will take precedence over `mmd_title_block`.
2475 [MultiMarkdown]: http://fletcherpenney.net/multimarkdown/
2477**Extension: `abbreviations`**\
2478Parses PHP Markdown Extra abbreviation keys, like
2480 *[HTML]: Hyper Text Markup Language
2482Note that the pandoc document model does not support
2483abbreviations, so if this extension is enabled, abbreviation keys are
2484simply skipped (as opposed to being parsed as paragraphs).
2486**Extension: `autolink_bare_uris`**\
2487Makes all absolute URIs into links, even when not surrounded by
2488pointy braces `<...>`.
2490**Extension: `ascii_identifiers`**\
2491Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
2492Accents are stripped off of accented latin letters, and non-latin
2495**Extension: `link_attributes`**\
2496Parses multimarkdown style key-value attributes on link and image references.
2497Note that pandoc's internal document model provides nowhere to put
2498these, so they are presently just ignored.
2500**Extension: `mmd_header_identifiers`**\
2501Parses multimarkdown style header identifiers (in square brackets,
2502after the header but before any trailing `#`s in an ATX header).
2507In addition to pandoc's extended markdown, the following markdown
2508variants are supported:
2510`markdown_phpextra` (PHP Markdown Extra)
2511: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,
2512 `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,
2513 `header_attributes`, `abbreviations`.
2515`markdown_github` (Github-flavored Markdown)
2516: `pipe_tables`, `raw_html`, `tex_math_single_backslash`,
2517 `fenced_code_blocks`, `fenced_code_attributes`, `auto_identifiers`,
2518 `ascii_identifiers`, `backtick_code_blocks`, `autolink_bare_uris`,
2519 `intraword_underscores`, `strikeout`, `hard_line_breaks`
2521`markdown_mmd` (MultiMarkdown)
2522: `pipe_tables` `raw_html`, `markdown_attribute`, `link_attributes`,
2523 `raw_tex`, `tex_math_double_backslash`, `intraword_underscores`,
2524 `mmd_title_block`, `footnotes`, `definition_lists`,
2525 `all_symbols_escapable`, `implicit_header_references`,
2526 `auto_identifiers`, `mmd_header_identifiers`
2528`markdown_strict` (Markdown.pl)
2531Producing slide shows with Pandoc
2532=================================
2534You can use Pandoc to produce an HTML + javascript slide presentation
2535that can be viewed via a web browser. There are five ways to do this,
2536using [S5], [DZSlides], [Slidy], [Slideous], or [reveal.js].
2537You can also produce a PDF slide show using LaTeX [beamer].
2539Here's the markdown source for a simple slide show, `habits.txt`:
2566 
2573To produce an HTML/javascript slide show, simply type
2575 pandoc -t FORMAT -s habits.txt -o habits.html
2577where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
2579For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
2580`-s/--standalone` option embeds a link to javascripts and CSS files, which are
2581assumed to be available at the relative path `s5/default` (for S5), `slideous`
2582(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
2583`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
2584`slideous-url`, `revealjs-url`, or `s5-url` variables; see `--variable`,
2585above.) For DZSlides, the (relatively short) javascript and css are included in
2588With all HTML slide formats, the `--self-contained` option can be used to
2589produce a single file that contains all of the data necessary to display the
2590slide show, including linked scripts, stylesheets, images, and videos.
2592To produce a PDF slide show using beamer, type
2594 pandoc -t beamer habits.txt -o habits.pdf
2596Note that a reveal.js slide show can also be converted to a PDF
2597by printing it to a file from the browser.
2599Structuring the slide show
2600--------------------------
2602By default, the *slide level* is the highest header level in
2603the hierarchy that is followed immediately by content, and not another
2604header, somewhere in the document. In the example above, level 1 headers
2605are always followed by level 2 headers, which are followed by content,
2606so 2 is the slide level. This default can be overridden using
2607the `--slide-level` option.
2609The document is carved up into slides according to the following
2612 * A horizontal rule always starts a new slide.
2614 * A header at the slide level always starts a new slide.
2616 * Headers *below* the slide level in the hierarchy create
2617 headers *within* a slide.
2619 * Headers *above* the slide level in the hierarchy create
2620 "title slides," which just contain the section title
2621 and help to break the slide show into sections.
2623 * A title page is constructed automatically from the document's title
2624 block, if present. (In the case of beamer, this can be disabled
2625 by commenting out some lines in the default template.)
2627These rules are designed to support many different styles of slide show. If
2628you don't care about structuring your slides into sections and subsections,
2629you can just use level 1 headers for all each slide. (In that case, level 1
2630will be the slide level.) But you can also structure the slide show into
2631sections, as in the example above.
2633Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
2634layout will be produced, with level 1 headers building horizontally
2635and level 2 headers building vertically. It is not recommended that
2636you use deeper nesting of section levels with reveal.js.
2641By default, these writers produces lists that display "all at once."
2642If you want your lists to display incrementally (one item at a time),
2643use the `-i` option. If you want a particular list to depart from the
2644default (that is, to display incrementally without the `-i` option and
2645all at once with the `-i` option), put it in a block quote:
2650In this way incremental and nonincremental lists can be mixed in
2656In reveal.js and beamer slide shows, you can add "pauses" within
2657a slide by including a paragraph containing three dots, separated
2660 # Slide with a pause
2662 content before the pause
2666 content after the pause
2671You can change the style of HTML slides by putting customized CSS files
2672in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
2673or `$DATADIR/slideous` (for Slideous),
2674where `$DATADIR` is the user data directory (see `--data-dir`, above).
2675The originals may be found in pandoc's system data directory (generally
2676`$CABALDIR/pandoc-VERSION/s5/default`). Pandoc will look there for any
2677files it does not find in the user data directory.
2679For dzslides, the CSS is included in the HTML file itself, and may
2682For reveal.js, themes can be used by setting the `theme` variable,
2687Or you can specify a custom stylesheet using the `--css` option.
2689To style beamer slides, you can specify a beamer "theme" or "colortheme"
2690using the `-V` option:
2692 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
2694Note that header attributes will turn into slide attributes
2695(on a `<div>` or `<section>`) in HTML slide formats, allowing you
2696to style individual slides. In Beamer, the only header attribute
2697that affects slides is the `allowframebreaks` class, which sets the
2698`allowframebreaks` option, causing multiple slides to be created
2699if the content overfills the frame. This is recommended especially for
2702 # References {.allowframebreaks}
2704Literate Haskell support
2705========================
2707If you append `+lhs` (or `+literate_haskell`) to an appropriate input or output
2708format (`markdown`, `mardkown_strict`, `rst`, or `latex` for input or output;
2709`beamer`, `html` or `html5` for output only), pandoc will treat the document as
2710literate Haskell source. This means that
2712 - In markdown input, "bird track" sections will be parsed as Haskell
2713 code rather than block quotations. Text between `\begin{code}`
2714 and `\end{code}` will also be treated as Haskell code.
2716 - In markdown output, code blocks with classes `haskell` and `literate`
2717 will be rendered using bird tracks, and block quotations will be
2718 indented one space, so they will not be treated as Haskell code.
2719 In addition, headers will be rendered setext-style (with underlines)
2720 rather than atx-style (with '#' characters). (This is because ghc
2721 treats '#' characters in column 1 as introducing line numbers.)
2723 - In restructured text input, "bird track" sections will be parsed
2726 - In restructured text output, code blocks with class `haskell` will
2727 be rendered using bird tracks.
2729 - In LaTeX input, text in `code` environments will be parsed as
2732 - In LaTeX output, code blocks with class `haskell` will be rendered
2733 inside `code` environments.
2735 - In HTML output, code blocks with class `haskell` will be rendered
2736 with class `literatehaskell` and bird tracks.
2740 pandoc -f markdown+lhs -t html
2742reads literate Haskell source formatted with markdown conventions and writes
2743ordinary HTML (without bird tracks).
2745 pandoc -f markdown+lhs -t html+lhs
2747writes HTML with the Haskell code in bird tracks, so it can be copied
2748and pasted as literate Haskell source.
2753Pandoc can be extended with custom writers written in [lua]. (Pandoc
2754includes a lua interpreter, so lua need not be installed separately.)
2756To use a custom writer, simply specify the path to the lua script
2757in place of the output format. For example:
2759 pandoc -t data/sample.lua
2761Creating a custom writer requires writing a lua function for each
2762possible element in a pandoc document. To get a documented example
2763which you can modify according to your needs, do
2765 pandoc --print-default-data-file sample.lua
2770© 2006-2013 John MacFarlane (jgm at berkeley dot edu). Released under the
2771[GPL], version 2 or greater. This software carries no warranty of
2772any kind. (See COPYRIGHT for full copyright and warranty notices.)
2773Other contributors include Recai Oktaş, Paulo Tanimoto, Peter Wang,
2774Andrea Rossato, Eric Kow, infinity0x, Luke Plant, shreevatsa.public,
2775Puneeth Chaganti, Paul Rivier, rodja.trappe, Bradley Kuhn, thsutton,
2776Nathan Gass, Jonathan Daugherty, Jérémy Bobbio, Justin Bogner, qerub,
2777Christopher Sawicki, Kelsey Hightower, Masayoshi Takahashi, Antoine
2778Latter, Ralf Stephan, Eric Seidel, B. Scott Michel, Gavin Beatty,
2779Sergey Astanin, Arlo O'Keeffe, Denis Laxalde, Brent Yorgey, David Lazar,
2782[markdown]: http://daringfireball.net/projects/markdown/
2783[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html
2784[S5]: http://meyerweb.com/eric/tools/s5/
2785[Slidy]: http://www.w3.org/Talks/Tools/Slidy/
2786[Slideous]: http://goessner.net/articles/slideous/
2787[HTML]: http://www.w3.org/TR/html40/
2788[HTML 5]: http://www.w3.org/TR/html5/
2789[XHTML]: http://www.w3.org/TR/xhtml1/
2790[LaTeX]: http://www.latex-project.org/
2791[beamer]: http://www.tex.ac.uk/CTAN/macros/latex/contrib/beamer
2792[ConTeXt]: http://www.pragma-ade.nl/
2793[RTF]: http://en.wikipedia.org/wiki/Rich_Text_Format
2794[DocBook]: http://www.docbook.org/
2795[OPML]: http://dev.opml.org/spec2.html
2796[OpenDocument]: http://opendocument.xml.org/
2797[ODT]: http://en.wikipedia.org/wiki/OpenDocument
2798[Textile]: http://redcloth.org/textile
2799[MediaWiki markup]: http://www.mediawiki.org/wiki/Help:Formatting
2800[Haddock markup]: http://www.haskell.org/haddock/doc/html/ch03s08.html
2801[groff man]: http://developer.apple.com/DOCUMENTATION/Darwin/Reference/ManPages/man7/groff_man.7.html
2802[Haskell]: http://www.haskell.org/
2803[GNU Texinfo]: http://www.gnu.org/software/texinfo/
2804[Emacs Org-Mode]: http://orgmode.org
2805[AsciiDoc]: http://www.methods.co.nz/asciidoc/
2806[EPUB]: http://www.idpf.org/
2807[GPL]: http://www.gnu.org/copyleft/gpl.html "GNU General Public License"
2808[DZSlides]: http://paulrouget.com/dzslides/
2809[ISO 8601 format]: http://www.w3.org/TR/NOTE-datetime
2810[Word docx]: http://www.microsoft.com/interop/openup/openxml/default.aspx
2811[PDF]: http://www.adobe.com/pdf/
2812[reveal.js]: http://lab.hakim.se/reveal-js/
2813[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
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