8`pandoc` [*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], [CommonMark], and (subsets of) [Textile],
16[reStructuredText], [HTML], [LaTeX], [MediaWiki markup], [TWiki
17markup], [Haddock markup], [OPML], [Emacs Org-mode], [DocBook],
18[txt2tags], [EPUB] and [Word docx]; and it can write plain text,
19[Markdown], [reStructuredText], [XHTML], [HTML 5], [LaTeX] (including
20[beamer] slide shows), [ConTeXt], [RTF], [OPML], [DocBook],
21[OpenDocument], [ODT], [Word docx], [GNU Texinfo], [MediaWiki markup],
22[DokuWiki markup], [Haddock markup], [EPUB] (v2 or v3),
23[FictionBook2], [Textile], [groff man] pages, [Emacs Org-Mode],
24[AsciiDoc], [InDesign ICML], and [Slidy], [Slideous], [DZSlides],
25[reveal.js] or [S5] HTML slide shows. It can also produce [PDF] output
26on systems where LaTeX is installed.
28Pandoc's enhanced version of markdown includes syntax for footnotes,
29tables, flexible ordered lists, definition lists, fenced code blocks,
30superscript, subscript, strikeout, title blocks, automatic tables of
31contents, embedded LaTeX math, citations, and markdown inside HTML block
32elements. (These enhancements, described below under
33[Pandoc's markdown](#pandocs-markdown), can be disabled using the
34`markdown_strict` input or output format.)
36In contrast to most existing tools for converting markdown to HTML, which
37use regex substitutions, Pandoc has a modular design: it consists of a
38set of readers, which parse text in a given format and produce a native
39representation of the document, and a set of writers, which convert
40this native representation into a target format. Thus, adding an input
41or output format requires only adding a reader or writer.
46If no *input-file* is specified, input is read from *stdin*.
47Otherwise, the *input-files* are concatenated (with a blank
48line between each) and used as input. Output goes to *stdout* by
49default (though output to *stdout* is disabled for the `odt`, `docx`,
50`epub`, and `epub3` output formats). For output to a file, use the
53 pandoc -o output.html input.txt
55By default, pandoc produces a document fragment, not a standalone
56document with a proper header and footer. To produce a standalone
57document, use the `-s` or `--standalone` flag:
59 pandoc -s -o output.html input.txt
61For more information on how standalone documents are produced, see
62[Templates](#templates), below.
64Instead of a file, an absolute URI may be given. In this case
65pandoc will fetch the content using HTTP:
67 pandoc -f html -t markdown http://www.fsf.org
69If multiple input files are given, `pandoc` will concatenate them all (with
70blank lines between them) before parsing. This feature is disabled for
71 binary input formats such as `EPUB` and `docx`.
73The format of the input and output can be specified explicitly using
74command-line options. The input format can be specified using the
75`-r/--read` or `-f/--from` options, the output format using the
76`-w/--write` or `-t/--to` options. Thus, to convert `hello.txt` from
77markdown to LaTeX, you could type:
79 pandoc -f markdown -t latex hello.txt
81To convert `hello.html` from html to markdown:
83 pandoc -f html -t markdown hello.html
85Supported output formats are listed below under the `-t/--to` option.
86Supported input formats are listed below under the `-f/--from` option. Note
87that the `rst`, `textile`, `latex`, and `html` readers are not complete;
88there are some constructs that they do not parse.
90If the input or output format is not specified explicitly, `pandoc`
91will attempt to guess it from the extensions of
92the input and output filenames. Thus, for example,
94 pandoc -o hello.tex hello.txt
96will convert `hello.txt` from markdown to LaTeX. If no output file
97is specified (so that output goes to *stdout*), or if the output file's
98extension is unknown, the output format will default to HTML.
99If no input file is specified (so that input comes from *stdin*), or
100if the input files' extensions are unknown, the input format will
101be assumed to be markdown unless explicitly specified.
103Pandoc uses the UTF-8 character encoding for both input and output.
104If your local character encoding is not UTF-8, you
105should pipe input and output through `iconv`:
107 iconv -t utf-8 input.txt | pandoc | iconv -f utf-8
109Note that in some output formats (such as HTML, LaTeX, ConTeXt,
110RTF, OPML, DocBook, and Texinfo), information about
111the character encoding is included in the document header, which
112will only be included if you use the `-s/--standalone` option.
117Earlier versions of pandoc came with a program, `markdown2pdf`, that
118used pandoc and pdflatex to produce a PDF. This is no longer needed,
119since `pandoc` can now produce `pdf` output itself. To produce a PDF, simply
120specify an output file with a `.pdf` extension. Pandoc will create a latex
121file and use pdflatex (or another engine, see `--latex-engine`) to convert it
124 pandoc test.txt -o test.pdf
126Production of a PDF requires that a LaTeX engine be installed (see
127`--latex-engine`, below), and assumes that the following LaTeX packages are
128available: `amssymb`, `amsmath`, `ifxetex`, `ifluatex`, `listings` (if the
129`--listings` option is used), `fancyvrb`, `longtable`, `booktabs`, `url`,
130`graphicx` and `grffile` (if the document contains images),
131 `hyperref`, `ulem`, `babel` (if the `lang` variable is set),
132`fontspec` (if `xelatex` or `lualatex` is used as the LaTeX engine), `xltxtra`
133and `xunicode` (if `xelatex` is used).
138A user who wants a drop-in replacement for `Markdown.pl` may create
139a symbolic link to the `pandoc` executable called `hsmarkdown`. When
140invoked under the name `hsmarkdown`, `pandoc` will behave as if
141invoked with `-f markdown_strict --email-obfuscation=references`,
142and all command-line options will be treated as regular arguments.
143However, this approach does not work under Cygwin, due to problems with
144its simulation of symbolic links.
146[Cygwin]: http://www.cygwin.com/
147[`iconv`]: http://www.gnu.org/software/libiconv/
148[CTAN]: http://www.ctan.org "Comprehensive TeX Archive Network"
149[TeX Live]: http://www.tug.org/texlive/
150[MacTeX]: http://www.tug.org/mactex/
158`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*
160: Specify input format. *FORMAT* can be `native` (native Haskell),
161 `json` (JSON version of native AST), `markdown` (pandoc's
162 extended markdown), `markdown_strict` (original unextended
163 markdown), `markdown_phpextra` (PHP Markdown Extra extended
164 markdown), `markdown_github` (github extended markdown),
165 `commonmark` (CommonMark markdown), `textile` (Textile), `rst`
166 (reStructuredText), `html` (HTML), `docbook` (DocBook), `t2t`
167 (txt2tags), `docx` (docx), `epub` (EPUB), `opml` (OPML), `org`
168 (Emacs Org-mode), `mediawiki` (MediaWiki markup), `twiki` (TWiki
169 markup), `haddock` (Haddock markup), or `latex` (LaTeX). If
170 `+lhs` is appended to `markdown`, `rst`, `latex`, or `html`, the
171 input will be treated as literate Haskell source: see [Literate
172 Haskell support](#literate-haskell-support), below. Markdown
173 syntax extensions can be individually enabled or disabled by
174 appending `+EXTENSION` or `-EXTENSION` to the format name. So, for
175 example, `markdown_strict+footnotes+definition_lists` is strict
176 markdown with footnotes and definition lists enabled, and
177 `markdown-pipe_tables+hard_line_breaks` is pandoc's markdown
178 without pipe tables and with hard line breaks. See [Pandoc's
179 markdown](#pandocs-markdown), below, for a list of extensions and
182`-t` *FORMAT*, `-w` *FORMAT*, `--to=`*FORMAT*, `--write=`*FORMAT*
184: Specify output format. *FORMAT* can be `native` (native Haskell),
185 `json` (JSON version of native AST), `plain` (plain text),
186 `markdown` (pandoc's extended markdown), `markdown_strict`
187 (original unextended markdown), `markdown_phpextra` (PHP Markdown
188 extra extended markdown), `markdown_github` (github extended
189 markdown), `commonmark` (CommonMark markdown), `rst`
190 (reStructuredText), `html` (XHTML 1), `html5` (HTML 5), `latex`
191 (LaTeX), `beamer` (LaTeX beamer slide show), `context` (ConTeXt),
192 `man` (groff man), `mediawiki` (MediaWiki markup), `dokuwiki`
193 (DokuWiki markup), `textile` (Textile), `org` (Emacs Org-Mode),
194 `texinfo` (GNU Texinfo), `opml` (OPML), `docbook` (DocBook),
195 `opendocument` (OpenDocument), `odt` (OpenOffice text document),
196 `docx` (Word docx), `haddock` (Haddock markup), `rtf` (rich text
197 format), `epub` (EPUB v2 book), `epub3` (EPUB v3), `fb2`
198 (FictionBook2 e-book), `asciidoc` (AsciiDoc), `icml` (InDesign
199 ICML), `slidy` (Slidy HTML and javascript slide show), `slideous`
200 (Slideous HTML and javascript slide show), `dzslides` (DZSlides
201 HTML5 + javascript slide show), `revealjs` (reveal.js HTML5 +
202 javascript slide show), `s5` (S5 HTML and javascript slide show),
203 or the path of a custom lua writer (see [Custom
204 writers](#custom-writers), below). Note that `odt`, `epub`, and
205 `epub3` output will not be directed to *stdout*; an output
206 filename must be specified using the `-o/--output` option. If
207 `+lhs` is appended to `markdown`, `rst`, `latex`, `beamer`,
208 `html`, or `html5`, the output will be rendered as literate
209 Haskell source: see [Literate Haskell
210 support](#literate-haskell-support), below. Markdown syntax
211 extensions can be individually enabled or disabled by appending
212 `+EXTENSION` or `-EXTENSION` to the format name, as described
215`-o` *FILE*, `--output=`*FILE*
217: Write output to *FILE* instead of *stdout*. If *FILE* is
218 `-`, output will go to *stdout*. (Exception: if the output
219 format is `odt`, `docx`, `epub`, or `epub3`, output to stdout is disabled.)
221`--data-dir=`*DIRECTORY*
223: Specify the user data directory to search for pandoc data files.
224 If this option is not specified, the default user data directory
225 will be used. This is
231 C:\Documents And Settings\USERNAME\Application Data\pandoc
235 C:\Users\USERNAME\AppData\Roaming\pandoc
237 in Windows 7. (You can find the default user data directory
238 on your system by looking at the output of `pandoc --version`.)
239 A `reference.odt`, `reference.docx`, `default.csl`,
240 `epub.css`, `templates`, `slidy`, `slideous`, or `s5` directory
241 placed in this directory will override pandoc's normal defaults.
245: Give verbose debugging output. Currently this only has an effect
261: Parse untranslatable HTML codes and LaTeX environments as raw HTML
262 or LaTeX, instead of ignoring them. Affects only HTML and LaTeX
263 input. Raw HTML can be printed in markdown, reStructuredText, HTML,
264 Slidy, Slideous, DZSlides, reveal.js, and S5 output; raw LaTeX
265 can be printed in markdown, reStructuredText, LaTeX, and ConTeXt output.
266 The default is for the readers to omit untranslatable HTML codes and
267 LaTeX environments. (The LaTeX reader does pass through untranslatable
268 LaTeX *commands*, even if `-R` is not specified.)
272: Produce typographically correct output, converting straight quotes
273 to curly quotes, `---` to em-dashes, `--` to en-dashes, and
274 `...` to ellipses. Nonbreaking spaces are inserted after certain
275 abbreviations, such as "Mr." (Note: This option is significant only when
276 the input format is `markdown`, `markdown_strict`, `textile` or `twiki`.
277 It is selected automatically when the input format is `textile` or the
278 output format is `latex` or `context`, unless `--no-tex-ligatures`
283: Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes: `-` before
284 a numeral is an en-dash, and `--` is an em-dash. This option is selected
285 automatically for `textile` input.
287`--base-header-level=`*NUMBER*
289: Specify the base level for headers (defaults to 1).
291`--indented-code-classes=`*CLASSES*
293: Specify classes to use for indented code blocks--for example,
294 `perl,numberLines` or `haskell`. Multiple classes may be separated
297`--default-image-extension=`*EXTENSION*
299: Specify a default extension to use when image paths/URLs have no
300 extension. This allows you to use the same source for formats that
301 require different kinds of images. Currently this option only affects
302 the markdown and LaTeX readers.
304`--filter=`*EXECUTABLE*
306: Specify an executable to be used as a filter transforming the
307 Pandoc AST after the input is parsed and before the output is
308 written. The executable should read JSON from stdin and write
309 JSON to stdout. The JSON must be formatted like pandoc's own
310 JSON input and output. The name of the output format will be
311 passed to the filter as the first argument. Hence,
313 pandoc --filter ./caps.py -t latex
317 pandoc -t json | ./caps.py latex | pandoc -f json -t latex
319 The latter form may be useful for debugging filters.
321 Filters may be written in any language. `Text.Pandoc.JSON`
322 exports `toJSONFilter` to facilitate writing filters in Haskell.
323 Those who would prefer to write filters in python can use the
324 module `pandocfilters`, installable from PyPI. See
325 <http://github.com/jgm/pandocfilters> for the module and several
326 examples. There are also pandoc filter libraries in
327 [PHP](https://github.com/vinai/pandocfilters-php),
328 [perl](https://metacpan.org/pod/Pandoc::Filter), and
329 [javascript/node.js](https://github.com/mvhenderson/pandoc-filter-node).
331 Note that the *EXECUTABLE* will be sought in the user's
332 `PATH`, and not in the working directory, if no directory is
333 provided. If you want to run a script in the working directory,
334 preface the filename with `./`.
336`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
338: Set the metadata field *KEY* to the value *VAL*. A value specified
339 on the command line overrides a value specified in the document.
340 Values will be parsed as YAML boolean or string values. If no value is
341 specified, the value will be treated as Boolean true. Like
342 `--variable`, `--metadata` causes template variables to be set.
343 But unlike `--variable`, `--metadata` affects the metadata of the
344 underlying document (which is accessible from filters and may be
345 printed in some output formats).
349: Normalize the document after reading: merge adjacent
350 `Str` or `Emph` elements, for example, and remove repeated `Space`s.
352`-p`, `--preserve-tabs`
354: Preserve tabs instead of converting them to spaces (the default).
355 Note that this will only affect tabs in literal code spans and code
356 blocks; tabs in regular text will be treated as spaces.
360: Specify the number of spaces per tab (default is 4).
362`--track-changes=accept`|`reject`|`all`
364: Specifies what to do with insertions and deletions produced by the MS
365 Word "track-changes" feature. `accept` (the default), inserts all
366 insertions, and ignores all deletions. `reject` inserts all
367 deletions and ignores insertions. `all` puts in both insertions
368 and deletions, wrapped in spans with `insertion` and `deletion`
369 classes, respectively. The author and time of change is
370 included. `all` is useful for scripting: only accepting changes
371 from a certain reviewer, say, or before a certain date. This
372 option only affects the docx reader.
374`--extract-media=`*DIR*
376: Extract images and other media contained in a docx or epub container
377 to the path *DIR*, creating it if necessary, and adjust the images
378 references in the document so they point to the extracted files.
379 This option only affects the docx and epub readers.
381General writer options
382----------------------
386: Produce output with an appropriate header and footer (e.g. a
387 standalone HTML, LaTeX, or RTF file, not a fragment). This option
388 is set automatically for `pdf`, `epub`, `epub3`, `fb2`, `docx`, and `odt`
393: Use *FILE* as a custom template for the generated document. Implies
394 `--standalone`. See [Templates](#templates) below for a description
395 of template syntax. If no extension is specified, an extension
396 corresponding to the writer will be added, so that `--template=special`
397 looks for `special.html` for HTML output. If the template is not
398 found, pandoc will search for it in the user data directory
399 (see `--data-dir`). If this option is not used, a default
400 template appropriate for the output format will be used (see
401 `-D/--print-default-template`).
403`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
405: Set the template variable *KEY* to the value *VAL* when rendering the
406 document in standalone mode. This is generally only useful when the
407 `--template` option is used to specify a custom template, since
408 pandoc automatically sets the variables used in the default
409 templates. If no *VAL* is specified, the key will be given the
412`-D` *FORMAT*, `--print-default-template=`*FORMAT*
414: Print the default template for an output *FORMAT*. (See `-t`
415 for a list of possible *FORMAT*s.)
417`--print-default-data-file=`*FILE*
419: Print a default data file.
423: Disable text wrapping in output. By default, text is wrapped
424 appropriately for the output format.
428: Specify length of lines in characters (for text wrapping).
430`--toc`, `--table-of-contents`
432: Include an automatically generated table of contents (or, in
433 the case of `latex`, `context`, and `rst`, an instruction to create
434 one) in the output document. This option has no effect on `man`,
435 `docbook`, `slidy`, `slideous`, `s5`, `docx`, or `odt` output.
437`--toc-depth=`*NUMBER*
439: Specify the number of section levels to include in the table
440 of contents. The default is 3 (which means that level 1, 2, and 3
441 headers will be listed in the contents).
445: Disables syntax highlighting for code blocks and inlines, even when
446 a language attribute is given.
448`--highlight-style=`*STYLE*
450: Specifies the coloring style to be used in highlighted source code.
451 Options are `pygments` (the default), `kate`, `monochrome`,
452 `espresso`, `zenburn`, `haddock`, and `tango`. For more information
453 on syntax highlighting in pandoc, see [Syntax highlighting], below.
455`-H` *FILE*, `--include-in-header=`*FILE*
457: Include contents of *FILE*, verbatim, at the end of the header.
458 This can be used, for example, to include special
459 CSS or javascript in HTML documents. This option can be used
460 repeatedly to include multiple files in the header. They will be
461 included in the order specified. Implies `--standalone`.
463`-B` *FILE*, `--include-before-body=`*FILE*
465: Include contents of *FILE*, verbatim, at the beginning of the
466 document body (e.g. after the `<body>` tag in HTML, or the
467 `\begin{document}` command in LaTeX). This can be used to include
468 navigation bars or banners in HTML documents. This option can be
469 used repeatedly to include multiple files. They will be included in
470 the order specified. Implies `--standalone`.
472`-A` *FILE*, `--include-after-body=`*FILE*
474: Include contents of *FILE*, verbatim, at the end of the document
475 body (before the `</body>` tag in HTML, or the
476 `\end{document}` command in LaTeX). This option can be be used
477 repeatedly to include multiple files. They will be included in the
478 order specified. Implies `--standalone`.
480Options affecting specific writers
481----------------------------------
485: Produce a standalone HTML file with no external dependencies, using
486 `data:` URIs to incorporate the contents of linked scripts, stylesheets,
487 images, and videos. The resulting file should be "self-contained,"
488 in the sense that it needs no external files and no net access to be
489 displayed properly by a browser. This option works only with HTML output
490 formats, including `html`, `html5`, `html+lhs`, `html5+lhs`, `s5`,
491 `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images, and
492 stylesheets at absolute URLs will be downloaded; those at relative URLs
493 will be sought relative to the working directory (if the first source
494 file is local) or relative to the base URL (if the first source
495 file is remote). `--self-contained` does not work with `--mathjax`.
499: Deprecated synonym for `--self-contained`.
503: Produce HTML5 instead of HTML4. This option has no effect for writers
504 other than `html`. (*Deprecated:* Use the `html5` output format instead.)
508: Use `<q>` tags for quotes in HTML.
512: Use only ascii characters in output. Currently supported only
513 for HTML output (which uses numerical entities instead of
514 UTF-8 when this option is selected).
518: Use reference-style links, rather than inline links, in writing markdown
519 or reStructuredText. By default inline links are used.
523: Use ATX style headers in markdown and asciidoc output. The default is
524 to use setext-style headers for levels 1-2, and then ATX headers.
528: Treat top-level headers as chapters in LaTeX, ConTeXt, and DocBook
529 output. When the LaTeX template uses the report, book, or
530 memoir class, this option is implied. If `beamer` is the output
531 format, top-level headers will become `\part{..}`.
533`-N`, `--number-sections`
535: Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.
536 By default, sections are not numbered. Sections with class
537 `unnumbered` will never be numbered, even if `--number-sections`
540`--number-offset=`*NUMBER*[`,`*NUMBER*`,`*...*]
542: Offset for section headings in HTML output (ignored in other
543 output formats). The first number is added to the section number for
544 top-level headers, the second for second-level headers, and so on.
545 So, for example, if you want the first top-level header in your
546 document to be numbered "6", specify `--number-offset=5`.
547 If your document starts with a level-2 header which you want to
548 be numbered "1.5", specify `--number-offset=1,4`.
549 Offsets are 0 by default. Implies `--number-sections`.
553: Do not convert quotation marks, apostrophes, and dashes to
554 the TeX ligatures when writing LaTeX or ConTeXt. Instead, just
555 use literal unicode characters. This is needed for using advanced
556 OpenType features with XeLaTeX and LuaLaTeX. Note: normally
557 `--smart` is selected automatically for LaTeX and ConTeXt
558 output, but it must be specified explicitly if `--no-tex-ligatures`
559 is selected. If you use literal curly quotes, dashes, and ellipses
560 in your source, then you may want to use `--no-tex-ligatures`
565: Use listings package for LaTeX code blocks
569: Make list items in slide shows display incrementally (one by one).
570 The default is for lists to be displayed all at once.
572`--slide-level=`*NUMBER*
574: Specifies that headers with the specified level create
575 slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headers
576 above this level in the hierarchy are used to divide the
577 slide show into sections; headers below this level create
578 subheads within a slide. The default is to set the slide level
579 based on the contents of the document; see
580 [Structuring the slide show](#structuring-the-slide-show), below.
584: Wrap sections in `<div>` tags (or `<section>` tags in HTML5),
585 and attach identifiers to the enclosing `<div>` (or `<section>`)
586 rather than the header itself.
587 See [Section identifiers](#header-identifiers-in-html-latex-and-context), below.
589`--email-obfuscation=none`|`javascript`|`references`
591: Specify a method for obfuscating `mailto:` links in HTML documents.
592 `none` leaves `mailto:` links as they are. `javascript` obfuscates
593 them using javascript. `references` obfuscates them by printing their
594 letters as decimal or hexadecimal character references.
596`--id-prefix=`*STRING*
598: Specify a prefix to be added to all automatically generated identifiers
599 in HTML and DocBook output, and to footnote numbers in markdown output.
600 This is useful for preventing duplicate identifiers when generating
601 fragments to be included in other pages.
603`-T` *STRING*, `--title-prefix=`*STRING*
605: Specify *STRING* as a prefix at the beginning of the title
606 that appears in the HTML header (but not in the title as it
607 appears at the beginning of the HTML body). Implies
610`-c` *URL*, `--css=`*URL*
612: Link to a CSS style sheet. This option can be be used repeatedly to
613 include multiple files. They will be included in the order specified.
615`--reference-odt=`*FILE*
617: Use the specified file as a style reference in producing an ODT.
618 For best results, the reference ODT should be a modified version
619 of an ODT produced using pandoc. The contents of the reference ODT
620 are ignored, but its stylesheets are used in the new ODT. If no
621 reference ODT is specified on the command line, pandoc will look
622 for a file `reference.odt` in the user data directory (see
623 `--data-dir`). If this is not found either, sensible defaults will be
626`--reference-docx=`*FILE*
628: Use the specified file as a style reference in producing a docx file.
629 For best results, the reference docx should be a modified version
630 of a docx file produced using pandoc. The contents of the reference docx
631 are ignored, but its stylesheets and document properties (including
632 margins, page size, header, and footer) are used in the new docx. If no
633 reference docx is specified on the command line, pandoc will look
634 for a file `reference.docx` in the user data directory (see
635 `--data-dir`). If this is not found either, sensible defaults will be
636 used. The following styles are used by pandoc: [paragraph]
637 Normal, Compact, Title, Subtitle, Authors, Date, Abstract, Heading 1,
638 Heading 2, Heading 3, Heading 4, Heading 5, Block Text, Definition Term,
639 Definition, Bibliography, Body Text, Table Caption, Image Caption,
640 Figure, FigureWithCaption;
641 [character] Default Paragraph Font, Body Text Char, Verbatim Char,
642 Footnote Reference, Hyperlink.
644`--epub-stylesheet=`*FILE*
646: Use the specified CSS file to style the EPUB. If no stylesheet
647 is specified, pandoc will look for a file `epub.css` in the
648 user data directory (see `--data-dir`). If it is not
649 found there, sensible defaults will be used.
651`--epub-cover-image=`*FILE*
653: Use the specified image as the EPUB cover. It is recommended
654 that the image be less than 1000px in width and height. Note that
655 in a markdown source document you can also specify `cover-image`
656 in a YAML metadata block (see [EPUB Metadata], below).
658`--epub-metadata=`*FILE*
660: Look in the specified XML file for metadata for the EPUB.
661 The file should contain a series of Dublin Core elements,
662 as documented at <http://dublincore.org/documents/dces/>.
665 <dc:rights>Creative Commons</dc:rights>
666 <dc:language>es-AR</dc:language>
668 By default, pandoc will include the following metadata elements:
669 `<dc:title>` (from the document title), `<dc:creator>` (from the
670 document authors), `<dc:date>` (from the document date, which should
671 be in [ISO 8601 format]), `<dc:language>` (from the `lang`
672 variable, or, if is not set, the locale), and `<dc:identifier
673 id="BookId">` (a randomly generated UUID). Any of these may be
674 overridden by elements in the metadata file.
676 Note: if the source document is markdown, a YAML metadata block
677 in the document can be used instead. See below under
680`--epub-embed-font=`*FILE*
682: Embed the specified font in the EPUB. This option can be repeated
683 to embed multiple fonts. Wildcards can also be used: for example,
684 `DejaVuSans-*.ttf`. However, if you use wildcards on the command
685 line, be sure to escape them or put the whole filename in single quotes,
686 to prevent them from being interpreted by the shell. To use the
687 embedded fonts, you will need to add declarations like the following
688 to your CSS (see `--epub-stylesheet`):
691 font-family: DejaVuSans;
694 src:url("DejaVuSans-Regular.ttf");
697 font-family: DejaVuSans;
700 src:url("DejaVuSans-Bold.ttf");
703 font-family: DejaVuSans;
706 src:url("DejaVuSans-Oblique.ttf");
709 font-family: DejaVuSans;
712 src:url("DejaVuSans-BoldOblique.ttf");
714 body { font-family: "DejaVuSans"; }
716`--epub-chapter-level=`*NUMBER*
718: Specify the header level at which to split the EPUB into separate
719 "chapter" files. The default is to split into chapters at level 1
720 headers. This option only affects the internal composition of the
721 EPUB, not the way chapters and sections are displayed to users. Some
722 readers may be slow if the chapter files are too large, so for large
723 documents with few level 1 headers, one might want to use a chapter
726`--latex-engine=pdflatex`|`lualatex`|`xelatex`
728: Use the specified LaTeX engine when producing PDF output.
729 The default is `pdflatex`. If the engine is not in your PATH,
730 the full path of the engine may be specified here.
732`--latex-engine-opt=`*STRING*
734: Use the given string as a command-line argument to the `latex-engine`.
735 If used multiple times, the arguments are provided with spaces between
736 them. Note that no check for duplicate options is done.
741`--bibliography=`*FILE*
743: Set the `bibliography` field in the document's metadata to *FILE*,
744 overriding any value set in the metadata, and process citations
745 using `pandoc-citeproc`. (This is equivalent to
746 `--metadata bibliography=FILE --filter pandoc-citeproc`.)
747 If `--natbib` or `--biblatex` is also supplied, `pandoc-citeproc` is not
748 used, making this equivalent to `--metadata bibliography=FILE`.
749 If you supply this argument multiple times, each *FILE* will be added
754: Set the `csl` field in the document's metadata to *FILE*,
755 overriding any value set in the metadata. (This is equivalent to
756 `--metadata csl=FILE`.)
757 This option is only relevant with `pandoc-citeproc`.
759`--citation-abbreviations=`*FILE*
761: Set the `citation-abbreviations` field in the document's metadata to
762 *FILE*, overriding any value set in the metadata. (This is equivalent to
763 `--metadata citation-abbreviations=FILE`.)
764 This option is only relevant with `pandoc-citeproc`.
768: Use natbib for citations in LaTeX output. This option is not for use
769 with the `pandoc-citeproc` filter or with PDF output. It is intended for
770 use in producing a LaTeX file that can be processed with pdflatex and
775: Use biblatex for citations in LaTeX output. This option is not for use
776 with the `pandoc-citeproc` filter or with PDF output. It is intended for
777 use in producing a LaTeX file that can be processed with pdflatex and
780Math rendering in HTML
781----------------------
783`-m` [*URL*], `--latexmathml`[`=`*URL*]
785: Use the [LaTeXMathML] script to display embedded TeX math in HTML output.
786 To insert a link to a local copy of the `LaTeXMathML.js` script,
787 provide a *URL*. If no *URL* is provided, the contents of the
788 script will be inserted directly into the HTML header, preserving
789 portability at the price of efficiency. If you plan to use math on
790 several pages, it is much better to link to a copy of the script,
795: Convert TeX math to MathML (in `docbook` as well as `html` and `html5`).
796 In standalone `html` output, a small javascript (or a link to such a
797 script if a *URL* is supplied) will be inserted that allows the MathML to
798 be viewed on some browsers.
802: Use [jsMath] to display embedded TeX math in HTML output.
803 The *URL* should point to the jsMath load script (e.g.
804 `jsMath/easy/load.js`); if provided, it will be linked to in
805 the header of standalone HTML documents. If a *URL* is not provided,
806 no link to the jsMath load script will be inserted; it is then
807 up to the author to provide such a link in the HTML template.
811: Use [MathJax] to display embedded TeX math in HTML output.
812 The *URL* should point to the `MathJax.js` load script.
813 If a *URL* is not provided, a link to the MathJax CDN will
818: Enclose TeX math in `<eq>` tags in HTML output. These can then
819 be processed by [gladTeX] to produce links to images of the typeset
824: Render TeX math using the [mimeTeX] CGI script. If *URL* is not
825 specified, it is assumed that the script is at `/cgi-bin/mimetex.cgi`.
829: Render TeX formulas using an external script that converts TeX
830 formulas to images. The formula will be concatenated with the URL
831 provided. If *URL* is not specified, the Google Chart API will be used.
835: Use [KaTeX] to display embedded TeX math in HTML output.
836 The *URL* should point to the `katex.js` load script. If a *URL* is
837 not provided, a link to the KaTeX CDN will be inserted.
839`--katex-stylesheet=`*URL*
841: The *URL* should point to the `katex.css` stylesheet. If this option is
842 not specified, a link to the KaTeX CDN will be inserted. Note that this
843 option does not imply `--katex`.
845Options for wrapper scripts
846---------------------------
850: Print information about command-line arguments to *stdout*, then exit.
851 This option is intended primarily for use in wrapper scripts.
852 The first line of output contains the name of the output file specified
853 with the `-o` option, or `-` (for *stdout*) if no output file was
854 specified. The remaining lines contain the command-line arguments,
855 one per line, in the order they appear. These do not include regular
856 Pandoc options and their arguments, but do include any options appearing
857 after a `--` separator at the end of the line.
861: Ignore command-line arguments (for use in wrapper scripts).
862 Regular Pandoc options are not ignored. Thus, for example,
864 pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1
868 pandoc -o foo.html -s
870[LaTeXMathML]: http://math.etsu.edu/LaTeXMathML/
871[jsMath]: http://www.math.union.edu/~dpvc/jsmath/
872[MathJax]: http://www.mathjax.org/
873[gladTeX]: http://ans.hsh.no/home/mgg/gladtex/
874[mimeTeX]: http://www.forkosh.com/mimetex.html
875[CSL]: http://CitationStyles.org
880When the `-s/--standalone` option is used, pandoc uses a template to
881add header and footer material that is needed for a self-standing
882document. To see the default template that is used, just type
886where `FORMAT` is the name of the output format. A custom template
887can be specified using the `--template` option. You can also override
888the system default templates for a given output format `FORMAT`
889by putting a file `templates/default.FORMAT` in the user data
890directory (see `--data-dir`, above). *Exceptions:* For `odt` output,
891customize the `default.opendocument` template. For `pdf` output,
892customize the `default.latex` template.
894Templates may contain *variables*. Variable names are sequences of
895alphanumerics, `-`, and `_`, starting with a letter. A variable name
896surrounded by `$` signs will be replaced by its value. For example,
897the string `$title$` in
899 <title>$title$</title>
901will be replaced by the document title.
903To write a literal `$` in a template, use `$$`.
905Some variables are set automatically by pandoc. These vary somewhat
906depending on the output format, but include metadata fields (such
907as `title`, `author`, and `date`) as well as the following:
910: contents specified by `-H/--include-in-header` (may have multiple
914: non-null value if `--toc/--table-of-contents` was specified
917: contents specified by `-B/--include-before-body` (may have
921: contents specified by `-A/--include-after-body` (may have
928: language code for HTML or LaTeX documents
931: base URL for Slidy documents (defaults to
932 `http://www.w3.org/Talks/Tools/Slidy2`)
935: base URL for Slideous documents (defaults to `slideous`)
938: base URL for S5 documents (defaults to `s5/default`)
941: base URL for reveal.js documents (defaults to `reveal.js`)
944: reveal.js or LaTeX beamer theme
947: reveal.js transition
950: font size (10pt, 11pt, 12pt) for LaTeX documents
953: document class for LaTeX documents
956: option for LaTeX documentclass, e.g. `oneside`; may be repeated
960: options for LaTeX `geometry` class, e.g. `margin=1in`;
961 may be repeated for multiple options
964: adjusts line spacing (requires the `setspace` package)
967: font package to use for LaTeX documents (with pdflatex):
968 TeXLive has `bookman` (Bookman), `utopia` or `fourier` (Utopia),
969 `fouriernc` (New Century Schoolbook), `times` or `txfonts` (Times),
970 `mathpazo` or `pxfonts` or `mathpple` (Palatino),
971 `libertine` (Linux Libertine), `arev` (Arev Sans),
972 and the default `lmodern`, among others.
974`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
975: fonts for LaTeX documents (works only with xelatex
976 and lualatex). Note that if `CJKmainfont` is used,
977 the `xeCJK` package must be available.
980: colortheme for LaTeX beamer documents
983: fonttheme for LaTeX beamer documents
986: color for internal links in LaTeX documents (`red`, `green`,
987 `magenta`, `cyan`, `blue`, `black`)
990: color for links in table of contents in LaTeX documents
993: color for external links in LaTeX documents
996: color for citation links in LaTeX documents
999: causes links to be printed as footnotes in LaTeX documents
1002: include table of contents in LaTeX documents
1005: level of section to include in table of contents in LaTeX documents
1008: title of table of contents (works only with EPUB and docx)
1011: include list of figures in LaTeX documents
1014: include list of tables in LaTeX documents
1017: bibliography to use for resolving references
1020: bibliography style in LaTeX, when used with `--natbib`
1023: section number in man pages
1026: header in man pages
1029: footer in man pages
1031Variables may be set at the command line using the `-V/--variable`
1032option. Variables set in this way override metadata fields with
1035Templates may contain conditionals. The syntax is as follows:
1043This will include `X` in the template if `variable` has a non-null
1044value; otherwise it will include `Y`. `X` and `Y` are placeholders for
1045any valid template text, and may include interpolated variables or other
1046conditionals. The `$else$` section may be omitted.
1048When variables can have multiple values (for example, `author` in
1049a multi-author document), you can use the `$for$` keyword:
1052 <meta name="author" content="$author$" />
1055You can optionally specify a separator to be used between
1058 $for(author)$$author$$sep$, $endfor$
1060A dot can be used to select a field of a variable that takes
1061an object as its value. So, for example:
1063 $author.name$ ($author.affiliation$)
1065If you use custom templates, you may need to revise them as pandoc
1066changes. We recommend tracking the changes in the default templates,
1067and modifying your custom templates accordingly. An easy way to do this
1068is to fork the pandoc-templates repository
1069(<http://github.com/jgm/pandoc-templates>) and merge in changes after each
1075Pandoc understands an extended and slightly revised version of
1076John Gruber's [markdown] syntax. This document explains the syntax,
1077noting differences from standard markdown. Except where noted, these
1078differences can be suppressed by using the `markdown_strict` format instead
1079of `markdown`. An extensions can be enabled by adding `+EXTENSION`
1080to the format name and disabled by adding `-EXTENSION`. For example,
1081`markdown_strict+footnotes` is strict markdown with footnotes
1082enabled, while `markdown-footnotes-pipe_tables` is pandoc's
1083markdown without footnotes or pipe tables.
1088Markdown is designed to be easy to write, and, even more importantly,
1091> A Markdown-formatted document should be publishable as-is, as plain
1092> text, without looking like it's been marked up with tags or formatting
1094> -- [John Gruber](http://daringfireball.net/projects/markdown/syntax#philosophy)
1096This principle has guided pandoc's decisions in finding syntax for
1097tables, footnotes, and other extensions.
1099There is, however, one respect in which pandoc's aims are different
1100from the original aims of markdown. Whereas markdown was originally
1101designed with HTML generation in mind, pandoc is designed for multiple
1102output formats. Thus, while pandoc allows the embedding of raw HTML,
1103it discourages it, and provides other, non-HTMLish ways of representing
1104important document elements like definition lists, tables, mathematics, and
1110A paragraph is one or more lines of text followed by one or more blank lines.
1111Newlines are treated as spaces, so you can reflow your paragraphs as you like.
1112If you need a hard line break, put two or more spaces at the end of a line.
1114#### Extension: `escaped_line_breaks` ####
1116A backslash followed by a newline is also a hard line break.
1117Note: in multiline and grid table cells, this is the only way
1118to create a hard line break, since trailing spaces in the cells
1124There are two kinds of headers, Setext and atx.
1126### Setext-style headers ###
1128A setext-style header is a line of text "underlined" with a row of `=` signs
1129(for a level one header) or `-` signs (for a level two header):
1137The header text can contain inline formatting, such as emphasis (see
1138[Inline formatting](#inline-formatting), below).
1141### Atx-style headers ###
1143An Atx-style header consists of one to six `#` signs and a line of
1144text, optionally followed by any number of `#` signs. The number of
1145`#` signs at the beginning of the line is the header level:
1147 ## A level-two header
1149 ### A level-three header ###
1151As with setext-style headers, the header text can contain formatting:
1153 # A level-one header with a [link](/url) and *emphasis*
1155#### Extension: `blank_before_header` ####
1157Standard markdown syntax does not require a blank line before a header.
1158Pandoc does require this (except, of course, at the beginning of the
1159document). The reason for the requirement is that it is all too easy for a
1160`#` to end up at the beginning of a line by accident (perhaps through line
1161wrapping). Consider, for example:
1163 I like several of their flavors of ice cream:
1164 #22, for example, and #5.
1167### Header identifiers in HTML, LaTeX, and ConTeXt ###
1169#### Extension: `header_attributes` ####
1171Headers can be assigned attributes using this syntax at the end
1172of the line containing the header text:
1174 {#identifier .class .class key=value key=value}
1176Thus, for example, the following headers will all be assigned the identifier
1181 ## My header ## {#foo}
1183 My other header {#foo}
1186(This syntax is compatible with [PHP Markdown Extra].)
1188Note that although this syntax allows assignment of classes and key/value
1189attributes, writers generally don't use all of this information. Identifiers,
1190classes, and key/value attributes are used in HTML and HTML-based formats such
1191as EPUB and slidy. Identifiers are used for labels and link anchors in the
1192LaTeX, ConTeXt, Textile, and AsciiDoc writers.
1194Headers with the class `unnumbered` will not be numbered, even if
1195`--number-sections` is specified. A single hyphen (`-`) in an attribute
1196context is equivalent to `.unnumbered`, and preferable in non-English
1203 # My header {.unnumbered}
1205#### Extension: `auto_identifiers` ####
1207A header without an explicitly specified identifier will be
1208automatically assigned a unique identifier based on the header text.
1209To derive the identifier from the header text,
1211 - Remove all formatting, links, etc.
1212 - Remove all footnotes.
1213 - Remove all punctuation, except underscores, hyphens, and periods.
1214 - Replace all spaces and newlines with hyphens.
1215 - Convert all alphabetic characters to lowercase.
1216 - Remove everything up to the first letter (identifiers may
1217 not begin with a number or punctuation mark).
1218 - If nothing is left after this, use the identifier `section`.
1223 ------------------------------- ----------------------------
1224 Header identifiers in HTML `header-identifiers-in-html`
1225 *Dogs*?--in *my* house? `dogs--in-my-house`
1226 [HTML], [S5], or [RTF]? `html-s5-or-rtf`
1227 3. Applications `applications`
1230These rules should, in most cases, allow one to determine the identifier
1231from the header text. The exception is when several headers have the
1232same text; in this case, the first will get an identifier as described
1233above; the second will get the same identifier with `-1` appended; the
1234third with `-2`; and so on.
1236These identifiers are used to provide link targets in the table of
1237contents generated by the `--toc|--table-of-contents` option. They
1238also make it easy to provide links from one section of a document to
1239another. A link to this section, for example, might look like this:
1242 [header identifiers](#header-identifiers-in-html-latex-and-context).
1244Note, however, that this method of providing links to sections works
1245only in HTML, LaTeX, and ConTeXt formats.
1247If the `--section-divs` option is specified, then each section will
1248be wrapped in a `div` (or a `section`, if `--html5` was specified),
1249and the identifier will be attached to the enclosing `<div>`
1250(or `<section>`) tag rather than the header itself. This allows entire
1251sections to be manipulated using javascript or treated differently in
1254#### Extension: `implicit_header_references` ####
1256Pandoc behaves as if reference links have been defined for each header.
1259 [header identifiers](#header-identifiers-in-html)
1263 [header identifiers]
1267 [header identifiers][]
1271 [the section on header identifiers][header identifiers]
1273If there are multiple headers with identical text, the corresponding
1274reference will link to the first one only, and you will need to use explicit
1275links to link to the others, as described above.
1277Like regular reference links, these references are case-insensitive.
1279Explicit link reference definitions always take priority over
1280implicit header references. So, in the following example, the
1281link will point to `bar`, not to `#foo`:
1292Markdown uses email conventions for quoting blocks of text.
1293A block quotation is one or more paragraphs or other block elements
1294(such as lists or headers), with each line preceded by a `>` character
1295and a space. (The `>` need not start at the left margin, but it should
1296not be indented more than three spaces.)
1298 > This is a block quote. This
1299 > paragraph has two lines.
1301 > 1. This is a list inside a block quote.
1304A "lazy" form, which requires the `>` character only on the first
1305line of each block, is also allowed:
1307 > This is a block quote. This
1308 paragraph has two lines.
1310 > 1. This is a list inside a block quote.
1313Among the block elements that can be contained in a block quote are
1314other block quotes. That is, block quotes can be nested:
1316 > This is a block quote.
1318 > > A block quote within a block quote.
1320#### Extension: `blank_before_blockquote` ####
1322Standard markdown syntax does not require a blank line before a block
1323quote. Pandoc does require this (except, of course, at the beginning of the
1324document). The reason for the requirement is that it is all too easy for a
1325`>` to end up at the beginning of a line by accident (perhaps through line
1326wrapping). So, unless the `markdown_strict` format is used, the following does
1327not produce a nested block quote in pandoc:
1329 > This is a block quote.
1333Verbatim (code) blocks
1334----------------------
1336### Indented code blocks ###
1338A block of text indented four spaces (or one tab) is treated as verbatim
1339text: that is, special characters do not trigger special formatting,
1340and all spaces and line breaks are preserved. For example,
1343 moveShip(5 * gravity, DOWN);
1346The initial (four space or one tab) indentation is not considered part
1347of the verbatim text, and is removed in the output.
1349Note: blank lines in the verbatim text need not begin with four spaces.
1352### Fenced code blocks ###
1354#### Extension: `fenced_code_blocks` ####
1356In addition to standard indented code blocks, Pandoc supports
1357*fenced* code blocks. These begin with a row of three or more
1358tildes (`~`) and end with a row of tildes that must be at least as long as
1359the starting row. Everything between these lines is treated as code. No
1360indentation is necessary:
1364 moveShip(5 * gravity, DOWN);
1368Like regular code blocks, fenced code blocks must be separated
1369from surrounding text by blank lines.
1371If the code itself contains a row of tildes or backticks, just use a longer
1372row of tildes or backticks at the start and end:
1376 code including tildes
1380#### Extension: `backtick_code_blocks` ####
1382Same as `fenced_code_blocks`, but uses backticks (`` ` ``) instead of tildes
1385#### Extension: `fenced_code_attributes` ####
1387Optionally, you may attach attributes to fenced or backtick code block using
1390 ~~~~ {#mycode .haskell .numberLines startFrom="100"}
1392 qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
1393 qsort (filter (>= x) xs)
1394 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1396Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and
1397`startFrom` is an attribute with value `100`. Some output formats can use this
1398information to do syntax highlighting. Currently, the only output formats
1399that uses this information are HTML and LaTeX. If highlighting is supported
1400for your output format and language, then the code block above will appear
1401highlighted, with numbered lines. (To see which languages are supported, do
1402`pandoc --version`.) Otherwise, the code block above will appear as follows:
1404 <pre id="mycode" class="haskell numberLines" startFrom="100">
1410A shortcut form can also be used for specifying the language of
1417This is equivalent to:
1423If the `fenced_code_attributes` extension is disabled, but
1424input contains class attribute(s) for the codeblock, the first
1425class attribute will be printed after the opening fence as a bare
1428To prevent all highlighting, use the `--no-highlight` flag.
1429To set the highlighting style, use `--highlight-style`.
1430For more information on highlighting, see [Syntax highlighting],
1436#### Extension: `line_blocks` ####
1438A line block is a sequence of lines beginning with a vertical bar (`|`)
1439followed by a space. The division into lines will be preserved in
1440the output, as will any leading spaces; otherwise, the lines will
1441be formatted as markdown. This is useful for verse and addresses:
1443 | The limerick packs laughs anatomical
1444 | In space that is quite economical.
1445 | But the good ones I've seen
1446 | So seldom are clean
1447 | And the clean ones so seldom are comical
1450 | Berkeley, CA 94718
1452The lines can be hard-wrapped if needed, but the continuation
1453line must begin with a space.
1455 | The Right Honorable Most Venerable and Righteous Samuel L.
1458 | Berkeley, CA 94718
1460This syntax is borrowed from [reStructuredText].
1467A bullet list is a list of bulleted list items. A bulleted list
1468item begins with a bullet (`*`, `+`, or `-`). Here is a simple
1475This will produce a "compact" list. If you want a "loose" list, in which
1476each item is formatted as a paragraph, put spaces between the items:
1484The bullets need not be flush with the left margin; they may be
1485indented one, two, or three spaces. The bullet must be followed
1488List items look best if subsequent lines are flush with the first
1489line (after the bullet):
1495But markdown also allows a "lazy" format:
1501### The four-space rule ###
1503A list item may contain multiple paragraphs and other block-level
1504content. However, subsequent paragraphs must be preceded by a blank line
1505and indented four spaces or a tab. The list will look better if the first
1506paragraph is aligned with the rest:
1512 * Second paragraph. With a code block, which must be indented
1517List items may include other lists. In this case the preceding blank
1518line is optional. The nested list must be indented four spaces or
1531As noted above, markdown allows you to write list items "lazily," instead of
1532indenting continuation lines. However, if there are multiple paragraphs or
1533other blocks in a list item, the first line of each must be indented.
1535 + A lazy, lazy, list
1538 + Another one; this looks
1541 Second paragraph of second
1544**Note:** Although the four-space rule for continuation paragraphs
1545comes from the official [markdown syntax guide], the reference implementation,
1546`Markdown.pl`, does not follow it. So pandoc will give different results than
1547`Markdown.pl` when authors have indented continuation paragraphs fewer than
1550The [markdown syntax guide] is not explicit whether the four-space
1551rule applies to *all* block-level content in a list item; it only
1552mentions paragraphs and code blocks. But it implies that the rule
1553applies to all block-level content (including nested lists), and
1554pandoc interprets it that way.
1556 [markdown syntax guide]:
1557 http://daringfireball.net/projects/markdown/syntax#list
1559### Ordered lists ###
1561Ordered lists work just like bulleted lists, except that the items
1562begin with enumerators rather than bullets.
1564In standard markdown, enumerators are decimal numbers followed
1565by a period and a space. The numbers themselves are ignored, so
1566there is no difference between this list:
1578#### Extension: `fancy_lists` ####
1580Unlike standard markdown, Pandoc allows ordered list items to be marked
1581with uppercase and lowercase letters and roman numerals, in addition to
1582arabic numerals. List markers may be enclosed in parentheses or followed by a
1583single right-parentheses or period. They must be separated from the
1584text that follows by at least one space, and, if the list marker is a
1585capital letter with a period, by at least two spaces.[^2]
1587[^2]: The point of this rule is to ensure that normal paragraphs
1588 starting with people's initials, like
1590 B. Russell was an English philosopher.
1592 do not get treated as list items.
1594 This rule will not prevent
1598 from being interpreted as a list item. In this case, a backslash
1603The `fancy_lists` extension also allows '`#`' to be used as an
1604ordered list marker in place of a numeral:
1609#### Extension: `startnum` ####
1611Pandoc also pays attention to the type of list marker used, and to the
1612starting number, and both of these are preserved where possible in the
1613output format. Thus, the following yields a list with numbers followed
1614by a single parenthesis, starting with 9, and a sublist with lowercase
1624Pandoc will start a new list each time a different type of list
1625marker is used. So, the following will create three lists:
1632If default list markers are desired, use `#.`:
1639### Definition lists ###
1641#### Extension: `definition_lists` ####
1643Pandoc supports definition lists, using the syntax of
1644[PHP Markdown Extra] with some extensions.[^3]
1650 Term 2 with *inline markup*
1654 { some code, part of Definition 2 }
1656 Third paragraph of definition 2.
1658Each term must fit on one line, which may optionally be followed by
1659a blank line, and must be followed by one or more definitions.
1660A definition begins with a colon or tilde, which may be indented one
1663A term may have multiple definitions, and each definition may consist of one or
1664more block elements (paragraph, code block, list, etc.), each indented four
1665spaces or one tab stop. The body of the definition (including the first line,
1666aside from the colon or tilde) should be indented four spaces. However,
1667as with other markdown lists, you can "lazily" omit indentation except
1668at the beginning of a paragraph or other block element:
1673 with lazy continuation.
1675 Second paragraph of the definition.
1677If you leave space before the definition (as in the example above),
1678the text of the definition will be treated as a paragraph. In some
1679output formats, this will mean greater spacing between term/definition
1680pairs. For a more compact definition list, omit the space before the
1690Note that space between items in a definition list is required.
1691(A variant that loosens this requirement, but disallows "lazy"
1692hard wrapping, can be activated with `compact_definition_lists`: see
1693[Non-pandoc extensions](#non-pandoc-extensions), below.)
1695[^3]: I have been influenced by the suggestions of [David Wheeler](http://www.justatheory.com/computers/markup/modest-markdown-proposal.html).
1697[PHP Markdown Extra]: http://www.michelf.com/projects/php-markdown/extra/
1700### Numbered example lists ###
1702#### Extension: `example_lists` ####
1704The special list marker `@` can be used for sequentially numbered
1705examples. The first list item with a `@` marker will be numbered '1',
1706the next '2', and so on, throughout the document. The numbered examples
1707need not occur in a single list; each new list using `@` will take up
1708where the last stopped. So, for example:
1710 (@) My first example will be numbered (1).
1711 (@) My second example will be numbered (2).
1713 Explanation of examples.
1715 (@) My third example will be numbered (3).
1717Numbered examples can be labeled and referred to elsewhere in the
1720 (@good) This is a good example.
1722 As (@good) illustrates, ...
1724The label can be any string of alphanumeric characters, underscores,
1728### Compact and loose lists ###
1730Pandoc behaves differently from `Markdown.pl` on some "edge
1731cases" involving lists. Consider this source:
1741Pandoc transforms this into a "compact list" (with no `<p>` tags around
1742"First", "Second", or "Third"), while markdown puts `<p>` tags around
1743"Second" and "Third" (but not "First"), because of the blank space
1744around "Third". Pandoc follows a simple rule: if the text is followed by
1745a blank line, it is treated as a paragraph. Since "Second" is followed
1746by a list, and not a blank line, it isn't treated as a paragraph. The
1747fact that the list is followed by a blank line is irrelevant. (Note:
1748Pandoc works this way even when the `markdown_strict` format is specified. This
1749behavior is consistent with the official markdown syntax description,
1750even though it is different from that of `Markdown.pl`.)
1753### Ending a list ###
1755What if you want to put an indented code block after a list?
1762Trouble! Here pandoc (like other markdown implementations) will treat
1763`{ my code block }` as the second paragraph of item two, and not as
1766To "cut off" the list after item two, you can insert some non-indented
1767content, like an HTML comment, which won't produce visible output in
1773 <!-- end of list -->
1777You can use the same trick if you want two consecutive lists instead
1793A line containing a row of three or more `*`, `-`, or `_` characters
1794(optionally separated by spaces) produces a horizontal rule:
1804Four kinds of tables may be used. The first three kinds presuppose the use of
1805a fixed-width font, such as Courier. The fourth kind can be used with
1806proportionally spaced fonts, as it does not require lining up columns.
1808#### Extension: `table_captions` ####
1810A caption may optionally be provided with all 4 kinds of tables (as
1811illustrated in the examples below). A caption is a paragraph beginning
1812with the string `Table:` (or just `:`), which will be stripped off.
1813It may appear either before or after the table.
1815#### Extension: `simple_tables` ####
1817Simple tables look like this:
1819 Right Left Center Default
1820 ------- ------ ---------- -------
1825 Table: Demonstration of simple table syntax.
1827The headers and table rows must each fit on one line. Column
1828alignments are determined by the position of the header text relative
1829to the dashed line below it:[^4]
1831 - If the dashed line is flush with the header text on the right side
1832 but extends beyond it on the left, the column is right-aligned.
1833 - If the dashed line is flush with the header text on the left side
1834 but extends beyond it on the right, the column is left-aligned.
1835 - If the dashed line extends beyond the header text on both sides,
1836 the column is centered.
1837 - If the dashed line is flush with the header text on both sides,
1838 the default alignment is used (in most cases, this will be left).
1840[^4]: This scheme is due to Michel Fortin, who proposed it on the
1841 [Markdown discussion list](http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html).
1843The table must end with a blank line, or a line of dashes followed by
1846The column headers may be omitted, provided a dashed line is used
1847to end the table. For example:
1849 ------- ------ ---------- -------
1853 ------- ------ ---------- -------
1855When headers are omitted, column alignments are determined on the basis
1856of the first line of the table body. So, in the tables above, the columns
1857would be right, left, center, and right aligned, respectively.
1859#### Extension: `multiline_tables` ####
1861Multiline tables allow headers and table rows to span multiple lines
1862of text (but cells that span multiple columns or rows of the table are
1863not supported). Here is an example:
1865 -------------------------------------------------------------
1866 Centered Default Right Left
1867 Header Aligned Aligned Aligned
1868 ----------- ------- --------------- -------------------------
1869 First row 12.0 Example of a row that
1870 spans multiple lines.
1872 Second row 5.0 Here's another one. Note
1873 the blank line between
1875 -------------------------------------------------------------
1877 Table: Here's the caption. It, too, may span
1880These work like simple tables, but with the following differences:
1882 - They must begin with a row of dashes, before the header text
1883 (unless the headers are omitted).
1884 - They must end with a row of dashes, then a blank line.
1885 - The rows must be separated by blank lines.
1887In multiline tables, the table parser pays attention to the widths of
1888the columns, and the writers try to reproduce these relative widths in
1889the output. So, if you find that one of the columns is too narrow in the
1890output, try widening it in the markdown source.
1892Headers may be omitted in multiline tables as well as simple tables:
1894 ----------- ------- --------------- -------------------------
1895 First row 12.0 Example of a row that
1896 spans multiple lines.
1898 Second row 5.0 Here's another one. Note
1899 the blank line between
1901 ----------- ------- --------------- -------------------------
1903 : Here's a multiline table without headers.
1905It is possible for a multiline table to have just one row, but the row
1906should be followed by a blank line (and then the row of dashes that ends
1907the table), or the table may be interpreted as a simple table.
1909#### Extension: `grid_tables` ####
1911Grid tables look like this:
1913 : Sample grid table.
1915 +---------------+---------------+--------------------+
1916 | Fruit | Price | Advantages |
1917 +===============+===============+====================+
1918 | Bananas | $1.34 | - built-in wrapper |
1919 | | | - bright color |
1920 +---------------+---------------+--------------------+
1921 | Oranges | $2.10 | - cures scurvy |
1923 +---------------+---------------+--------------------+
1925The row of `=`s separates the header from the table body, and can be
1926omitted for a headerless table. The cells of grid tables may contain
1927arbitrary block elements (multiple paragraphs, code blocks, lists,
1928etc.). Alignments are not supported, nor are cells that span multiple
1929columns or rows. Grid tables can be created easily using [Emacs table mode].
1931 [Emacs table mode]: http://table.sourceforge.net/
1933#### Extension: `pipe_tables` ####
1935Pipe tables look like this:
1937 | Right | Left | Default | Center |
1938 |------:|:-----|---------|:------:|
1939 | 12 | 12 | 12 | 12 |
1940 | 123 | 123 | 123 | 123 |
1943 : Demonstration of pipe table syntax.
1945The syntax is [the same as in PHP markdown extra]. The beginning and
1946ending pipe characters are optional, but pipes are required between all
1947columns. The colons indicate column alignment as shown. The header
1948cannot be omitted. To simulate a headerless table, include a header
1951Since the pipes indicate column boundaries, columns need not be vertically
1952aligned, as they are in the above example. So, this is a perfectly
1953legal (though ugly) pipe table:
1961The cells of pipe tables cannot contain block elements like paragraphs
1962and lists, and cannot span multiple lines. Note also that in LaTeX/PDF
1963output, the cells produced by pipe tables will not wrap, since there
1964is no information available about relative widths. If you want content
1965to wrap within cells, use multiline or grid tables.
1967 [the same as in PHP markdown extra]:
1968 http://michelf.ca/projects/php-markdown/extra/#table
1970Note: Pandoc also recognizes pipe tables of the following
1971form, as can be produced by Emacs' orgtbl-mode:
1978The difference is that `+` is used instead of `|`. Other orgtbl features
1979are not supported. In particular, to get non-default column alignment,
1980you'll need to add colons as above.
1985#### Extension: `pandoc_title_block` ####
1987If the file begins with a title block
1990 % author(s) (separated by semicolons)
1993it will be parsed as bibliographic information, not regular text. (It
1994will be used, for example, in the title of standalone LaTeX or HTML
1995output.) The block may contain just a title, a title and an author,
1996or all three elements. If you want to include an author but no
1997title, or a title and a date but no author, you need a blank line:
2006The title may occupy multiple lines, but continuation lines must
2007begin with leading space, thus:
2012If a document has multiple authors, the authors may be put on
2013separate lines with leading space, or separated by semicolons, or
2014both. So, all of the following are equivalent:
2019 % Author One; Author Two
2024The date must fit on one line.
2026All three metadata fields may contain standard inline formatting
2027(italics, links, footnotes, etc.).
2029Title blocks will always be parsed, but they will affect the output only
2030when the `--standalone` (`-s`) option is chosen. In HTML output, titles
2031will appear twice: once in the document head -- this is the title that
2032will appear at the top of the window in a browser -- and once at the
2033beginning of the document body. The title in the document head can have
2034an optional prefix attached (`--title-prefix` or `-T` option). The title
2035in the body appears as an H1 element with class "title", so it can be
2036suppressed or reformatted with CSS. If a title prefix is specified with
2037`-T` and no title block appears in the document, the title prefix will
2038be used by itself as the HTML title.
2040The man page writer extracts a title, man page section number, and
2041other header and footer information from the title line. The title
2042is assumed to be the first word on the title line, which may optionally
2043end with a (single-digit) section number in parentheses. (There should
2044be no space between the title and the parentheses.) Anything after
2045this is assumed to be additional footer and header text. A single pipe
2046character (`|`) should be used to separate the footer text from the header
2051will yield a man page with the title `PANDOC` and section 1.
2053 % PANDOC(1) Pandoc User Manuals
2055will also have "Pandoc User Manuals" in the footer.
2057 % PANDOC(1) Pandoc User Manuals | Version 4.0
2059will also have "Version 4.0" in the header.
2061#### Extension: `yaml_metadata_block` ####
2063A YAML metadata block is a valid YAML object, delimited by a line of three
2064hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
2065(`...`) at the bottom. A YAML metadata block may occur anywhere in the
2066document, but if it is not at the beginning, it must be preceded by a blank
2067line. (Note that, because of the way pandoc concatenates input files when
2068several are provided, you may also keep the metadata in a separate YAML file
2069and pass it to pandoc as an argument, along with your markdown files:
2071 pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
2073Just be sure that the YAML file begins with `---` and ends with `---` or
2076Metadata will be taken from the fields of the YAML object and added to any
2077existing document metadata. Metadata can contain lists and objects (nested
2078arbitrarily), but all string scalars will be interpreted as markdown. Fields
2079with names ending in an underscore will be ignored by pandoc. (They may be
2080given a role by external processors.)
2082A document may contain multiple metadata blocks. The metadata fields will
2083be combined through a *left-biased union*: if two metadata blocks attempt
2084to set the same field, the value from the first block will be taken.
2086When pandoc is used with `-t markdown` to create a markdown document,
2087a YAML metadata block will be produced only if the `-s/--standalone`
2088option is used. All of the metadata will appear in a single block
2089at the beginning of the document.
2091Note that YAML escaping rules must be followed. Thus, for example,
2092if a title contains a colon, it must be quoted. The pipe character
2093(`|`) can be used to begin an indented block that will be interpreted
2094literally, without need for escaping. This form is necessary
2095when the field contains blank lines:
2098 title: 'This is the title: it contains a colon'
2101 affiliation: University of Somewhere
2103 affiliation: University of Nowhere
2104 tags: [nothing, nothingness]
2106 This is the abstract.
2108 It consists of two paragraphs.
2111Template variables will be set automatically from the metadata. Thus, for
2112example, in writing HTML, the variable `abstract` will be set to the HTML
2113equivalent of the markdown in the `abstract` field:
2115 <p>This is the abstract.</p>
2116 <p>It consists of two paragraphs.</p>
2118Note: The `author` variable in the default templates expects a simple list or
2119string. To use the structured authors in the example, you would need a
2120custom template. For example:
2124 $author.name$$if(author.affiliation)$ ($author.affiliation$)$endif$
2134#### Extension: `all_symbols_escapable` ####
2136Except inside a code block or inline code, any punctuation or space
2137character preceded by a backslash will be treated literally, even if it
2138would normally indicate formatting. Thus, for example, if one writes
2148 <strong>hello</strong>
2150This rule is easier to remember than standard markdown's rule,
2151which allows only the following characters to be backslash-escaped:
2155(However, if the `markdown_strict` format is used, the standard markdown rule
2158A backslash-escaped space is parsed as a nonbreaking space. It will
2159appear in TeX output as `~` and in HTML and XML as `\ ` or
2162A backslash-escaped newline (i.e. a backslash occurring at the end of
2163a line) is parsed as a hard line break. It will appear in TeX output as
2164`\\` and in HTML as `<br />`. This is a nice alternative to
2165markdown's "invisible" way of indicating hard line breaks using
2166two trailing spaces on a line.
2168Backslash escapes do not work in verbatim contexts.
2175If the `--smart` option is specified, pandoc will produce typographically
2176correct output, converting straight quotes to curly quotes, `---` to
2177em-dashes, `--` to en-dashes, and `...` to ellipses. Nonbreaking spaces
2178are inserted after certain abbreviations, such as "Mr."
2180Note: if your LaTeX template uses the `csquotes` package, pandoc will
2181detect automatically this and use `\enquote{...}` for quoted text.
2188To *emphasize* some text, surround it with `*`s or `_`, like this:
2190 This text is _emphasized with underscores_, and this
2191 is *emphasized with asterisks*.
2193Double `*` or `_` produces **strong emphasis**:
2195 This is **strong emphasis** and __with underscores__.
2197A `*` or `_` character surrounded by spaces, or backslash-escaped,
2198will not trigger emphasis:
2200 This is * not emphasized *, and \*neither is this\*.
2202#### Extension: `intraword_underscores` ####
2204Because `_` is sometimes used inside words and identifiers,
2205pandoc does not interpret a `_` surrounded by alphanumeric
2206characters as an emphasis marker. If you want to emphasize
2207just part of a word, use `*`:
2209 feas*ible*, not feas*able*.
2214#### Extension: `strikeout` ####
2216To strikeout a section of text with a horizontal line, begin and end it
2217with `~~`. Thus, for example,
2219 This ~~is deleted text.~~
2222### Superscripts and subscripts ###
2224#### Extension: `superscript`, `subscript` ####
2226Superscripts may be written by surrounding the superscripted text by `^`
2227characters; subscripts may be written by surrounding the subscripted
2228text by `~` characters. Thus, for example,
2230 H~2~O is a liquid. 2^10^ is 1024.
2232If the superscripted or subscripted text contains spaces, these spaces
2233must be escaped with backslashes. (This is to prevent accidental
2234superscripting and subscripting through the ordinary use of `~` and `^`.)
2235Thus, if you want the letter P with 'a cat' in subscripts, use
2236`P~a\ cat~`, not `P~a cat~`.
2241To make a short span of text verbatim, put it inside backticks:
2243 What is the difference between `>>=` and `>>`?
2245If the verbatim text includes a backtick, use double backticks:
2247 Here is a literal backtick `` ` ``.
2249(The spaces after the opening backticks and before the closing
2250backticks will be ignored.)
2252The general rule is that a verbatim span starts with a string
2253of consecutive backticks (optionally followed by a space)
2254and ends with a string of the same number of backticks (optionally
2255preceded by a space).
2257Note that backslash-escapes (and other markdown constructs) do not
2258work in verbatim contexts:
2260 This is a backslash followed by an asterisk: `\*`.
2262#### Extension: `inline_code_attributes` ####
2264Attributes can be attached to verbatim text, just as with
2265[fenced code blocks](#fenced-code-blocks):
2271To write small caps, you can use an HTML span tag:
2273 <span style="font-variant:small-caps;">Small caps</span>
2275(The semicolon is optional and there may be space after the
2276colon.) This will work in all output formats that support small caps.
2281#### Extension: `tex_math_dollars` ####
2283Anything between two `$` characters will be treated as TeX math. The
2284opening `$` must have a non-space character immediately to its right,
2285while the closing `$` must have a non-space character immediately to its
2286left, and must not be followed immediately by a digit. Thus,
2287`$20,000 and $30,000` won't parse as math. If for some reason
2288you need to enclose text in literal `$` characters, backslash-escape
2289them and they won't be treated as math delimiters.
2291TeX math will be printed in all output formats. How it is rendered
2292depends on the output format:
2294Markdown, LaTeX, Org-Mode, ConTeXt
2295 ~ It will appear verbatim between `$` characters.
2298 ~ It will be rendered using an interpreted text role `:math:`, as described
2299 [here](http://docutils.sourceforge.net/docs/ref/rst/roles.html#math)
2302 ~ It will be rendered as `latexmath:[...]`.
2305 ~ It will be rendered inside a `@math` command.
2308 ~ It will be rendered verbatim without `$`'s.
2311 ~ It will be rendered inside `<math>` tags.
2314 ~ It will be rendered inside `<span class="math">` tags.
2316RTF, OpenDocument, ODT
2317 ~ It will be rendered, if possible, using unicode characters,
2318 and will otherwise appear verbatim.
2321 ~ If the `--mathml` flag is used, it will be rendered using mathml
2322 in an `inlineequation` or `informalequation` tag. Otherwise it
2323 will be rendered, if possible, using unicode characters.
2326 ~ It will be rendered using OMML math markup.
2329 ~ If the `--webtex` option is used, formulas are rendered as images
2330 using Google Charts or other compatible web service, downloaded
2331 and embedded in the e-book. Otherwise, they will appear verbatim.
2333HTML, Slidy, DZSlides, S5, EPUB
2334 ~ The way math is rendered in HTML will depend on the
2335 command-line options selected:
2337 1. The default is to render TeX math as far as possible using unicode
2338 characters, as with RTF, DocBook, and OpenDocument output. Formulas
2339 are put inside a `span` with `class="math"`, so that they may be
2340 styled differently from the surrounding text if needed.
2342 2. If the `--latexmathml` option is used, TeX math will be displayed
2343 between `$` or `$$` characters and put in `<span>` tags with class `LaTeX`.
2344 The [LaTeXMathML] script will be used to render it as formulas.
2345 (This trick does not work in all browsers, but it works in Firefox.
2346 In browsers that do not support LaTeXMathML, TeX math will appear
2347 verbatim between `$` characters.)
2349 3. If the `--jsmath` option is used, TeX math will be put inside
2350 `<span>` tags (for inline math) or `<div>` tags (for display math)
2351 with class `math`. The [jsMath] script will be used to render
2354 4. If the `--mimetex` option is used, the [mimeTeX] CGI script will
2355 be called to generate images for each TeX formula. This should
2356 work in all browsers. The `--mimetex` option takes an optional URL
2357 as argument. If no URL is specified, it will be assumed that the
2358 mimeTeX CGI script is at `/cgi-bin/mimetex.cgi`.
2360 5. If the `--gladtex` option is used, TeX formulas will be enclosed
2361 in `<eq>` tags in the HTML output. The resulting `htex` file may then
2362 be processed by [gladTeX], which will produce image files for each
2363 formula and an `html` file with links to these images. So, the
2366 pandoc -s --gladtex myfile.txt -o myfile.htex
2367 gladtex -d myfile-images myfile.htex
2368 # produces myfile.html and images in myfile-images
2370 6. If the `--webtex` option is used, TeX formulas will be converted
2371 to `<img>` tags that link to an external script that converts
2372 formulas to images. The formula will be URL-encoded and concatenated
2373 with the URL provided. If no URL is specified, the Google Chart
2374 API will be used (`http://chart.apis.google.com/chart?cht=tx&chl=`).
2376 7. If the `--mathjax` option is used, TeX math will be displayed
2377 between `\(...\)` (for inline math) or `\[...\]` (for display
2378 math) and put in `<span>` tags with class `math`.
2379 The [MathJax] script will be used to render it as formulas.
2384#### Extension: `raw_html` ####
2386Markdown allows you to insert raw HTML (or DocBook) anywhere in a document
2387(except verbatim contexts, where `<`, `>`, and `&` are interpreted
2388literally). (Technically this is not an extension, since standard
2389markdown allows it, but it has been made an extension so that it can
2390be disabled if desired.)
2392The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
2393DZSlides, EPUB, Markdown, and Textile output, and suppressed in other
2396#### Extension: `markdown_in_html_blocks` ####
2398Standard markdown allows you to include HTML "blocks": blocks
2399of HTML between balanced tags that are separated from the surrounding text
2400with blank lines, and start and end at the left margin. Within
2401these blocks, everything is interpreted as HTML, not markdown;
2402so (for example), `*` does not signify emphasis.
2404Pandoc behaves this way when the `markdown_strict` format is used; but
2405by default, pandoc interprets material between HTML block tags as markdown.
2406Thus, for example, Pandoc will turn
2411 <td>[a link](http://google.com)</td>
2419 <td><em>one</em></td>
2420 <td><a href="http://google.com">a link</a></td>
2424whereas `Markdown.pl` will preserve it as is.
2426There is one exception to this rule: text between `<script>` and
2427`<style>` tags is not interpreted as markdown.
2429This departure from standard markdown should make it easier to mix
2430markdown with HTML block elements. For example, one can surround
2431a block of markdown text with `<div>` tags without preventing it
2432from being interpreted as markdown.
2434#### Extension: `native_divs` ####
2436Use native pandoc `Div` blocks for content inside `<div>` tags.
2437For the most part this should give the same output as
2438`markdown_in_html_blocks`, but it makes it easier to write pandoc
2439filters to manipulate groups of blocks.
2441#### Extension: `native_spans` ####
2443Use native pandoc `Span` blocks for content inside `<span>` tags.
2444For the most part this should give the same output as `raw_html`,
2445but it makes it easier to write pandoc filters to manipulate groups
2451#### Extension: `raw_tex` ####
2453In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be
2454included in a document. Inline TeX commands will be preserved and passed
2455unchanged to the LaTeX and ConTeXt writers. Thus, for example, you can use
2456LaTeX to include BibTeX citations:
2458 This result was proved in \cite{jones.1967}.
2460Note that in LaTeX environments, like
2462 \begin{tabular}{|l|l|}\hline
2463 Age & Frequency \\ \hline
2466 36--45 & 22 \\ \hline
2469the material between the begin and end tags will be interpreted as raw
2470LaTeX, not as markdown.
2472Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
2478#### Extension: `latex_macros` ####
2480For output formats other than LaTeX, pandoc will parse LaTeX `\newcommand` and
2481`\renewcommand` definitions and apply the resulting macros to all LaTeX
2482math. So, for example, the following will work in all output formats,
2485 \newcommand{\tuple}[1]{\langle #1 \rangle}
2489In LaTeX output, the `\newcommand` definition will simply be passed
2490unchanged to the output.
2496Markdown allows links to be specified in several ways.
2498### Automatic links ###
2500If you enclose a URL or email address in pointy brackets, it
2504 <sam@green.eggs.ham>
2508An inline link consists of the link text in square brackets,
2509followed by the URL in parentheses. (Optionally, the URL can
2510be followed by a link title, in quotes.)
2512 This is an [inline link](/url), and here's [one with
2513 a title](http://fsf.org "click here for a good time!").
2515There can be no space between the bracketed part and the parenthesized part.
2516The link text can contain formatting (such as emphasis), but the title cannot.
2518Email addresses in inline links are not autodetected, so they have to be
2519prefixed with `mailto`:
2521 [Write me!](mailto:sam@green.eggs.ham)
2523### Reference links ###
2525An *explicit* reference link has two parts, the link itself and the link
2526definition, which may occur elsewhere in the document (either
2527before or after the link).
2529The link consists of link text in square brackets, followed by a label in
2530square brackets. (There can be space between the two.) The link definition
2531consists of the bracketed label, followed by a colon and a space, followed by
2532the URL, and optionally (after a space) a link title either in quotes or in
2533parentheses. The label must not be parseable as a citation (assuming
2534the `citations` extension is enabled): citations take precedence over
2537Here are some examples:
2539 [my label 1]: /foo/bar.html "My title, optional"
2541 [my label 3]: http://fsf.org (The free software foundation)
2542 [my label 4]: /bar#special 'A title in single quotes'
2544The URL may optionally be surrounded by angle brackets:
2546 [my label 5]: <http://foo.bar.baz>
2548The title may go on the next line:
2550 [my label 3]: http://fsf.org
2551 "The free software foundation"
2553Note that link labels are not case sensitive. So, this will work:
2555 Here is [my link][FOO]
2559In an *implicit* reference link, the second pair of brackets is
2564 [my website]: http://foo.bar.baz
2566Note: In `Markdown.pl` and most other markdown implementations,
2567reference link definitions cannot occur in nested constructions
2568such as list items or block quotes. Pandoc lifts this arbitrary
2569seeming restriction. So the following is fine in pandoc, though
2570not in most other implementations:
2576#### Extension: `shortcut_reference_links` ####
2578In a *shortcut* reference link, the second pair of brackets may
2583 [my website]: http://foo.bar.baz
2585### Internal links ###
2587To link to another section of the same document, use the automatically
2588generated identifier (see [Header identifiers in HTML, LaTeX, and
2589ConTeXt](#header-identifiers-in-html-latex-and-context), below).
2592 See the [Introduction](#introduction).
2596 See the [Introduction].
2598 [Introduction]: #introduction
2600Internal links are currently supported for HTML formats (including
2601HTML slide shows and EPUB), LaTeX, and ConTeXt.
2606A link immediately preceded by a `!` will be treated as an image.
2607The link text will be used as the image's alt text:
2609 
2613 [movie reel]: movie.gif
2615#### Extension: `implicit_figures` ####
2617An image occurring by itself in a paragraph will be rendered as
2618a figure with a caption.[^5] (In LaTeX, a figure environment will be
2619used; in HTML, the image will be placed in a `div` with class
2620`figure`, together with a caption in a `p` with class `caption`.)
2621The image's alt text will be used as the caption.
2623 
2625[^5]: This feature is not yet implemented for RTF, OpenDocument, or
2626 ODT. In those formats, you'll just get an image in a paragraph by
2627 itself, with no caption.
2629If you just want a regular inline image, just make sure it is not
2630the only thing in the paragraph. One way to do this is to insert a
2631nonbreaking space after the image:
2633 \
2639#### Extension: `footnotes` ####
2641Pandoc's markdown allows footnotes, using the following syntax:
2643 Here is a footnote reference,[^1] and another.[^longnote]
2645 [^1]: Here is the footnote.
2647 [^longnote]: Here's one with multiple blocks.
2649 Subsequent paragraphs are indented to show that they
2650 belong to the previous footnote.
2654 The whole paragraph can be indented, or just the first
2655 line. In this way, multi-paragraph footnotes work like
2656 multi-paragraph list items.
2658 This paragraph won't be part of the note, because it
2661The identifiers in footnote references may not contain spaces, tabs,
2662or newlines. These identifiers are used only to correlate the
2663footnote reference with the note itself; in the output, footnotes
2664will be numbered sequentially.
2666The footnotes themselves need not be placed at the end of the
2667document. They may appear anywhere except inside other block elements
2668(lists, block quotes, tables, etc.).
2670#### Extension: `inline_notes` ####
2672Inline footnotes are also allowed (though, unlike regular notes,
2673they cannot contain multiple paragraphs). The syntax is as follows:
2675 Here is an inline note.^[Inlines notes are easier to write, since
2676 you don't have to pick an identifier and move down to type the
2679Inline and regular footnotes may be mixed freely.
2685#### Extension: `citations` ####
2687Using an external filter, `pandoc-citeproc`, pandoc can automatically generate
2688citations and a bibliography in a number of styles. Basic usage is
2690 pandoc --filter pandoc-citeproc myinput.txt
2692In order to use this feature, you will need to specify a bibliography file
2693using the `bibliography` metadata field in a YAML metadata section, or
2694`--bibliography` command line argument. You can supply multiple `--bibliography`
2695arguments or set `bibliography` metadata field to YAML array, if you want to
2696use multiple bibliography files.
2697The bibliography may have any of these formats:
2699 Format File extension
2700 ------------ --------------
2713Note that `.bib` can generally be used with both BibTeX and BibLaTeX
2714files, but you can use `.bibtex` to force BibTeX.
2716Note that `pandoc-citeproc --bib2json` and `pandoc-citeproc --bib2yaml`
2717can produce `.json` and `.yaml` files from any of the supported formats.
2719In-field markup: In bibtex and biblatex databases, pandoc-citeproc parses
2720(a subset of) LaTeX markup; in CSL JSON databases, an HTML-like markup
2721([specs](http://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields));
2722and in CSL YAML databases, pandoc markdown. `pandoc-citeproc -j` and `-y`
2723interconvert these markup formats as far as possible.
2725As an alternative to specifying a bibliography file, you can include
2726the citation data directly in the `references` field of the
2727document's YAML metadata. The field should contain an array of
2728YAML-encoded references, for example:
2732 - type: article-journal
2744 title: 'Molecular structure of nucleic acids: a structure for deoxyribose
2746 title-short: Molecular structure of nucleic acids
2747 container-title: Nature
2751 DOI: 10.1038/171737a0
2752 URL: http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html
2756(`pandoc-citeproc --bib2yaml` can produce these from a bibliography file in one
2757of the supported formats.)
2759By default, `pandoc-citeproc` will use the Chicago Manual of Style author-date
2760format for citations and references. To use another style, you will need to
2761specify a [CSL] 1.0 style file in the `csl` metadata field. A repository of CSL
2762styles can be found at <https://github.com/citation-style-language/styles>. See
2763also <http://zotero.org/styles> for easy browsing. A primer on creating and
2764modifying CSL styles can be found at
2765<http://citationstyles.org/downloads/primer.html>.
2767Citations go inside square brackets and are separated by semicolons.
2768Each citation must have a key, composed of '@' + the citation
2769identifier from the database, and may optionally have a prefix,
2770a locator, and a suffix. The citation key must begin with a letter, digit,
2771or `_`, and may contain alphanumerics, `_`, and internal punctuation
2772characters (`:.#$%&-+?<>~/`). Here are some examples:
2774 Blah blah [see @doe99, pp. 33-35; also @smith04, ch. 1].
2776 Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
2778 Blah blah [@smith04; @doe99].
2780A minus sign (`-`) before the `@` will suppress mention of
2781the author in the citation. This can be useful when the
2782author is already mentioned in the text:
2784 Smith says blah [-@smith04].
2786You can also write an in-text citation, as follows:
2790 @smith04 [p. 33] says blah.
2792If the style calls for a list of works cited, it will be placed
2793at the end of the document. Normally, you will want to end your
2794document with an appropriate header:
2800The bibliography will be inserted after this header. Note that
2801the `unnumbered` class will be added to this header, so that the
2802section will not be numbered.
2804If you want to include items in the bibliography without actually
2805citing them in the body text, you can define a dummy `nocite` metadata
2806field and put the citations there:
2815In this example, the document will contain a citation for `item3`
2816only, but the bibliography will contain entries for `item1`, `item2`, and
2819For LaTeX or PDF output, you can also use NatBib or BibLaTeX
2820to render bibliography. In order to do so, specify bibliography files as
2821outlined above, and add `--natbib` or `--biblatex` argument to `pandoc`
2822invocation. Bear in mind that bibliography files have to be in respective
2823format (either BibTeX or BibLaTeX).
2825Non-pandoc extensions
2826---------------------
2828The following markdown syntax extensions are not enabled by default
2829in pandoc, but may be enabled by adding `+EXTENSION` to the format
2830name, where `EXTENSION` is the name of the extension. Thus, for
2831example, `markdown+hard_line_breaks` is markdown with hard line breaks.
2833#### Extension: `lists_without_preceding_blankline` ####
2835Allow a list to occur right after a paragraph, with no intervening
2838#### Extension: `hard_line_breaks` ####
2840Causes all newlines within a paragraph to be interpreted as hard line
2841breaks instead of spaces.
2843#### Extension: `ignore_line_breaks` ####
2845Causes newlines within a paragraph to be ignored, rather than being
2846treated as spaces or as hard line breaks. This option is intended for
2847use with East Asian languages where spaces are not used between words,
2848but text is divided into lines for readability.
2850#### Extension: `tex_math_single_backslash` ####
2852Causes anything between `\(` and `\)` to be interpreted as inline
2853TeX math, and anything between `\[` and `\]` to be interpreted
2854as display TeX math. Note: a drawback of this extension is that
2855it precludes escaping `(` and `[`.
2857#### Extension: `tex_math_double_backslash` ####
2859Causes anything between `\\(` and `\\)` to be interpreted as inline
2860TeX math, and anything between `\\[` and `\\]` to be interpreted
2863#### Extension: `markdown_attribute` ####
2865By default, pandoc interprets material inside block-level tags as markdown.
2866This extension changes the behavior so that markdown is only parsed
2867inside block-level tags if the tags have the attribute `markdown=1`.
2869#### Extension: `mmd_title_block` ####
2871Enables a [MultiMarkdown] style title block at the top of
2872the document, for example:
2876 Date: September 1, 2008
2877 Comment: This is a sample mmd title block, with
2878 a field spanning multiple lines.
2880See the MultiMarkdown documentation for details. If `pandoc_title_block` or
2881`yaml_metadata_block` is enabled, it will take precedence over
2884 [MultiMarkdown]: http://fletcherpenney.net/multimarkdown/
2886#### Extension: `abbreviations` ####
2888Parses PHP Markdown Extra abbreviation keys, like
2890 *[HTML]: Hyper Text Markup Language
2892Note that the pandoc document model does not support
2893abbreviations, so if this extension is enabled, abbreviation keys are
2894simply skipped (as opposed to being parsed as paragraphs).
2896#### Extension: `autolink_bare_uris` ####
2898Makes all absolute URIs into links, even when not surrounded by
2899pointy braces `<...>`.
2901#### Extension: `ascii_identifiers` ####
2903Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
2904Accents are stripped off of accented latin letters, and non-latin
2907#### Extension: `link_attributes` ####
2909Parses multimarkdown style key-value attributes on link and image references.
2910Note that pandoc's internal document model provides nowhere to put
2911these, so they are presently just ignored.
2913#### Extension: `mmd_header_identifiers` ####
2915Parses multimarkdown style header identifiers (in square brackets,
2916after the header but before any trailing `#`s in an ATX header).
2918#### Extension: `compact_definition_lists` ####
2920Activates the definition list syntax of pandoc 1.12.x and earlier.
2921This syntax differs from the one described [above](#definition-lists)
2924 - No blank line is required between consecutive items of the
2926 - To get a "tight" or "compact" list, omit space between consecutive
2927 items; the space between a term and its definition does not affect
2929 - Lazy wrapping of paragraphs is not allowed: the entire definition must
2930 be indented four spaces.[^6]
2932[^6]: To see why laziness is incompatible with relaxing the requirement
2933 of a blank line between items, consider the following example:
2940 Is this a single list item with two definitions of "bar," the first of
2941 which is lazily wrapped, or two list items? To remove the ambiguity
2942 we must either disallow lazy wrapping or require a blank line between
2948In addition to pandoc's extended markdown, the following markdown
2949variants are supported:
2951`markdown_phpextra` (PHP Markdown Extra)
2952: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,
2953 `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,
2954 `header_attributes`, `abbreviations`, `shortcut_reference_links`.
2956`markdown_github` (GitHub-flavored Markdown)
2957: `pipe_tables`, `raw_html`, `tex_math_single_backslash`,
2958 `fenced_code_blocks`, `auto_identifiers`,
2959 `ascii_identifiers`, `backtick_code_blocks`, `autolink_bare_uris`,
2960 `intraword_underscores`, `strikeout`, `hard_line_breaks`,
2961 `shortcut_reference_links`.
2963`markdown_mmd` (MultiMarkdown)
2964: `pipe_tables` `raw_html`, `markdown_attribute`, `link_attributes`,
2965 `raw_tex`, `tex_math_double_backslash`, `intraword_underscores`,
2966 `mmd_title_block`, `footnotes`, `definition_lists`,
2967 `all_symbols_escapable`, `implicit_header_references`,
2968 `auto_identifiers`, `mmd_header_identifiers`,
2969 `shortcut_reference_links`.
2971`markdown_strict` (Markdown.pl)
2974Extensions with formats other than markdown
2975-------------------------------------------
2977Some of the extensions discussed above can be used with formats
2980* `auto_identifiers` can be used with `latex`, `rst`, `mediawiki`,
2981 and `textile` input (and is used by default).
2983* `tex_math_dollars`, `tex_math_single_backslash`, and
2984 `tex_math_double_backslash` can be used with `html` input.
2985 (This is handy for reading web pages formatted using MathJax,
2988Producing slide shows with Pandoc
2989=================================
2991You can use Pandoc to produce an HTML + javascript slide presentation
2992that can be viewed via a web browser. There are five ways to do this,
2993using [S5], [DZSlides], [Slidy], [Slideous], or [reveal.js].
2994You can also produce a PDF slide show using LaTeX [beamer].
2996Here's the markdown source for a simple slide show, `habits.txt`:
3023 
3030To produce an HTML/javascript slide show, simply type
3032 pandoc -t FORMAT -s habits.txt -o habits.html
3034where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
3036For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
3037`-s/--standalone` option embeds a link to javascripts and CSS files, which are
3038assumed to be available at the relative path `s5/default` (for S5), `slideous`
3039(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
3040`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
3041`slideous-url`, `revealjs-url`, or `s5-url` variables; see `--variable`,
3042above.) For DZSlides, the (relatively short) javascript and css are included in
3045With all HTML slide formats, the `--self-contained` option can be used to
3046produce a single file that contains all of the data necessary to display the
3047slide show, including linked scripts, stylesheets, images, and videos.
3049To produce a PDF slide show using beamer, type
3051 pandoc -t beamer habits.txt -o habits.pdf
3053Note that a reveal.js slide show can also be converted to a PDF
3054by printing it to a file from the browser.
3056Structuring the slide show
3057--------------------------
3059By default, the *slide level* is the highest header level in
3060the hierarchy that is followed immediately by content, and not another
3061header, somewhere in the document. In the example above, level 1 headers
3062are always followed by level 2 headers, which are followed by content,
3063so 2 is the slide level. This default can be overridden using
3064the `--slide-level` option.
3066The document is carved up into slides according to the following
3069 * A horizontal rule always starts a new slide.
3071 * A header at the slide level always starts a new slide.
3073 * Headers *below* the slide level in the hierarchy create
3074 headers *within* a slide.
3076 * Headers *above* the slide level in the hierarchy create
3077 "title slides," which just contain the section title
3078 and help to break the slide show into sections.
3080 * A title page is constructed automatically from the document's title
3081 block, if present. (In the case of beamer, this can be disabled
3082 by commenting out some lines in the default template.)
3084These rules are designed to support many different styles of slide show. If
3085you don't care about structuring your slides into sections and subsections,
3086you can just use level 1 headers for all each slide. (In that case, level 1
3087will be the slide level.) But you can also structure the slide show into
3088sections, as in the example above.
3090Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
3091layout will be produced, with level 1 headers building horizontally
3092and level 2 headers building vertically. It is not recommended that
3093you use deeper nesting of section levels with reveal.js.
3098By default, these writers produce lists that display "all at once."
3099If you want your lists to display incrementally (one item at a time),
3100use the `-i` option. If you want a particular list to depart from the
3101default (that is, to display incrementally without the `-i` option and
3102all at once with the `-i` option), put it in a block quote:
3107In this way incremental and nonincremental lists can be mixed in
3113You can add "pauses" within a slide by including a paragraph containing
3114three dots, separated by spaces:
3116 # Slide with a pause
3118 content before the pause
3122 content after the pause
3127You can change the style of HTML slides by putting customized CSS files
3128in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
3129or `$DATADIR/slideous` (for Slideous),
3130where `$DATADIR` is the user data directory (see `--data-dir`, above).
3131The originals may be found in pandoc's system data directory (generally
3132`$CABALDIR/pandoc-VERSION/s5/default`). Pandoc will look there for any
3133files it does not find in the user data directory.
3135For dzslides, the CSS is included in the HTML file itself, and may
3138For reveal.js, themes can be used by setting the `theme` variable,
3143Or you can specify a custom stylesheet using the `--css` option.
3145To style beamer slides, you can specify a beamer "theme" or "colortheme"
3146using the `-V` option:
3148 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
3150Note that header attributes will turn into slide attributes
3151(on a `<div>` or `<section>`) in HTML slide formats, allowing you
3152to style individual slides. In Beamer, the only header attribute
3153that affects slides is the `allowframebreaks` class, which sets the
3154`allowframebreaks` option, causing multiple slides to be created
3155if the content overfills the frame. This is recommended especially for
3158 # References {.allowframebreaks}
3163reveal.js has good support for speaker notes. You can add notes to your
3164markdown document thus:
3169 - It can contain markdown
3174To show the notes window, press `s` while viewing the presentation.
3175Notes are not yet supported for other slide formats, but the notes
3176will not appear on the slides themselves.
3178Marking frames "fragile" in beamer
3179----------------------------------
3181Sometimes it is necessary to add the LaTeX `[fragile]` option to
3182a frame in beamer (for example, when using the `minted` environment).
3183This can be forced by adding the `fragile` class to the header
3184introducing the slide:
3186 # Fragile slide {.fragile}
3191EPUB metadata may be specified using the `--epub-metadata` option, but
3192if the source document is markdown, it is better to use a YAML metadata
3193block. Here is an example:
3200 text: An investigation of metadata
3208 text: doi:10.234234.234/33
3210 rights: © 2007 John Smith, CC BY-NC
3213The following fields are recognized:
3216 ~ Either a string value or an object with fields `text` and
3217 `scheme`. Valid values for `scheme` are `ISBN-10`,
3218 `GTIN-13`, `UPC`, `ISMN-10`, `DOI`, `LCCN`, `GTIN-14`,
3219 `ISBN-13`, `Legal deposit number`, `URN`, `OCLC`,
3220 `ISMN-13`, `ISBN-A`, `JP`, `OLCC`.
3223 ~ Either a string value, or an object with fields `file-as` and
3224 `type`, or a list of such objects. Valid values for `type` are
3225 `main`, `subtitle`, `short`, `collection`, `edition`, `extended`.
3228 ~ Either a string value, or an object with fields `role`, `file-as`,
3229 and `text`, or a list of such objects. Valid values for `role` are
3230 [marc relators](http://www.loc.gov/marc/relators/relaterm.html), but
3231 pandoc will attempt to translate the human-readable versions
3232 (like "author" and "editor") to the appropriate marc relators.
3235 ~ Same format as `creator`.
3238 ~ A string value in `YYYY-MM-DD` format. (Only the year is necessary.)
3239 Pandoc will attempt to convert other common date formats.
3242 ~ A string value in [RFC5646] format. Pandoc will default to the local
3243 language if nothing is specified.
3246 ~ A string value or a list of such values.
3267 ~ A string value (path to cover image).
3270 ~ A string value (path to CSS stylesheet).
3272`page-progression-direction`
3273 ~ Either `ltr` or `rtl`. Specifies the `page-progression-direction`
3274 spine [attribute][EPUBspine].
3276Literate Haskell support
3277========================
3279If you append `+lhs` (or `+literate_haskell`) to an appropriate input or output
3280format (`markdown`, `markdown_strict`, `rst`, or `latex` for input or output;
3281`beamer`, `html` or `html5` for output only), pandoc will treat the document as
3282literate Haskell source. This means that
3284 - In markdown input, "bird track" sections will be parsed as Haskell
3285 code rather than block quotations. Text between `\begin{code}`
3286 and `\end{code}` will also be treated as Haskell code.
3288 - In markdown output, code blocks with classes `haskell` and `literate`
3289 will be rendered using bird tracks, and block quotations will be
3290 indented one space, so they will not be treated as Haskell code.
3291 In addition, headers will be rendered setext-style (with underlines)
3292 rather than atx-style (with '#' characters). (This is because ghc
3293 treats '#' characters in column 1 as introducing line numbers.)
3295 - In restructured text input, "bird track" sections will be parsed
3298 - In restructured text output, code blocks with class `haskell` will
3299 be rendered using bird tracks.
3301 - In LaTeX input, text in `code` environments will be parsed as
3304 - In LaTeX output, code blocks with class `haskell` will be rendered
3305 inside `code` environments.
3307 - In HTML output, code blocks with class `haskell` will be rendered
3308 with class `literatehaskell` and bird tracks.
3312 pandoc -f markdown+lhs -t html
3314reads literate Haskell source formatted with markdown conventions and writes
3315ordinary HTML (without bird tracks).
3317 pandoc -f markdown+lhs -t html+lhs
3319writes HTML with the Haskell code in bird tracks, so it can be copied
3320and pasted as literate Haskell source.
3325Pandoc will automatically highlight syntax in fenced code blocks that
3326are marked with a language name. (See [Extension:
3327`inline_code_attributes`] and [Extension: `fenced_code_attributes`],
3328above.) The Haskell library [highlighting-kate] is used for
3329highlighting, which works in HTML, Docx, and LaTeX/PDF output.
3330The color scheme can be selected using the `--highlight-style` option.
3331The default color scheme is `pygments`, which imitates the default color
3332scheme used by the Python library pygments, but pygments is not actually
3333used to do the highlighting.
3335To see a list of language names that pandoc will recognize, type
3338To disable highlighting, use the `--no-highlight` option.
3343Pandoc can be extended with custom writers written in [lua]. (Pandoc
3344includes a lua interpreter, so lua need not be installed separately.)
3346To use a custom writer, simply specify the path to the lua script
3347in place of the output format. For example:
3349 pandoc -t data/sample.lua
3351Creating a custom writer requires writing a lua function for each
3352possible element in a pandoc document. To get a documented example
3353which you can modify according to your needs, do
3355 pandoc --print-default-data-file sample.lua
3360© 2006-2015 John MacFarlane (jgm@berkeley.edu). Released under the
3361[GPL], version 2 or greater. This software carries no warranty of
3362any kind. (See COPYRIGHT for full copyright and warranty notices.)
3367Alexander Kondratskiy,
3369Alexander V Vershilov,
3370Alfred Wechselberger,
3376Beni Cherniavsky-Paskin,
3384Christoffer Ackelman,
3414Jaime Marquínez Ferrándiz,
3442Matthias C. M. Troffaes,
3486[markdown]: http://daringfireball.net/projects/markdown/
3487[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html
3488[S5]: http://meyerweb.com/eric/tools/s5/
3489[Slidy]: http://www.w3.org/Talks/Tools/Slidy/
3490[Slideous]: http://goessner.net/articles/slideous/
3491[HTML]: http://www.w3.org/TR/html40/
3492[HTML 5]: http://www.w3.org/TR/html5/
3493[XHTML]: http://www.w3.org/TR/xhtml1/
3494[LaTeX]: http://www.latex-project.org/
3495[beamer]: http://www.tex.ac.uk/CTAN/macros/latex/contrib/beamer
3496[ConTeXt]: http://www.pragma-ade.nl/
3497[RTF]: http://en.wikipedia.org/wiki/Rich_Text_Format
3498[DocBook]: http://www.docbook.org/
3499[OPML]: http://dev.opml.org/spec2.html
3500[OpenDocument]: http://opendocument.xml.org/
3501[ODT]: http://en.wikipedia.org/wiki/OpenDocument
3502[Textile]: http://redcloth.org/textile
3503[MediaWiki markup]: http://www.mediawiki.org/wiki/Help:Formatting
3504[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
3505[TWiki markup]: http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
3506[Haddock markup]: http://www.haskell.org/haddock/doc/html/ch03s08.html
3507[groff man]: http://developer.apple.com/DOCUMENTATION/Darwin/Reference/ManPages/man7/groff_man.7.html
3508[Haskell]: http://www.haskell.org/
3509[GNU Texinfo]: http://www.gnu.org/software/texinfo/
3510[Emacs Org-Mode]: http://orgmode.org
3511[AsciiDoc]: http://www.methods.co.nz/asciidoc/
3512[GPL]: http://www.gnu.org/copyleft/gpl.html "GNU General Public License"
3513[DZSlides]: http://paulrouget.com/dzslides/
3514[ISO 8601 format]: http://www.w3.org/TR/NOTE-datetime
3515[Word docx]: http://www.microsoft.com/interop/openup/openxml/default.aspx
3516[PDF]: http://www.adobe.com/pdf/
3517[reveal.js]: http://lab.hakim.se/reveal-js/
3518[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
3519[lua]: http://www.lua.org
3520[marc relators]: http://www.loc.gov/marc/relators/relaterm.html
3521[RFC5646]: http://tools.ietf.org/html/rfc5646
3522[InDesign ICML]: https://www.adobe.com/content/dam/Adobe/en/devnet/indesign/cs55-docs/IDML/idml-specification.pdf
3523[txt2tags]: http://txt2tags.org/
3524[EPUB]: http://idpf.org/epub
3525[EPUBspine]: http://www.idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
3526[KaTeX]: https://github.com/Khan/KaTeX
3527[CommonMark]: http://commonmark.org
3528[highlighting-kate]: http://github.com/jgm/highlighting-kate
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