8pandoc [*options*] [*input-file*]...
13Pandoc is a [Haskell] library for converting from one markup format to
14another, and a command-line tool that uses this library. It can read
15[markdown] and (subsets of) [Textile], [reStructuredText], [HTML],
16[LaTeX], [MediaWiki markup], [TWiki markup], [Haddock markup], [OPML],
17[Emacs Org-mode], [DocBook], [txt2tags], [EPUB] and [Word docx]; and
18it can write plain text, [markdown], [reStructuredText], [XHTML],
19[HTML 5], [LaTeX] (including [beamer] slide shows), [ConTeXt], [RTF],
20[OPML], [DocBook], [OpenDocument], [ODT], [Word docx], [GNU Texinfo],
21[MediaWiki markup], [DokuWiki markup], [Haddock markup], [EPUB] (v2 or v3),
22[FictionBook2], [Textile], [groff man] pages, [Emacs Org-Mode], [AsciiDoc],
23[InDesign ICML], and [Slidy], [Slideous], [DZSlides], [reveal.js] or
24[S5] HTML slide shows. It can also produce [PDF] output on systems where
27Pandoc's enhanced version of markdown includes syntax for footnotes,
28tables, flexible ordered lists, definition lists, fenced code blocks,
29superscript, subscript, strikeout, title blocks, automatic tables of
30contents, embedded LaTeX math, citations, and markdown inside HTML block
31elements. (These enhancements, described below under
32[Pandoc's markdown](#pandocs-markdown), can be disabled using the
33`markdown_strict` input or output format.)
35In contrast to most existing tools for converting markdown to HTML, which
36use regex substitutions, Pandoc has a modular design: it consists of a
37set of readers, which parse text in a given format and produce a native
38representation of the document, and a set of writers, which convert
39this native representation into a target format. Thus, adding an input
40or output format requires only adding a reader or writer.
45If no *input-file* is specified, input is read from *stdin*.
46Otherwise, the *input-files* are concatenated (with a blank
47line between each) and used as input. Output goes to *stdout* by
48default (though output to *stdout* is disabled for the `odt`, `docx`,
49`epub`, and `epub3` output formats). For output to a file, use the
52 pandoc -o output.html input.txt
54By default, pandoc produces a document fragment, not a standalone
55document with a proper header and footer. To produce a standalone
56document, use the `-s` or `--standalone` flag:
58 pandoc -s -o output.html input.txt
60For more information on how standalone documents are produced, see
61[Templates](#templates), below.
63Instead of a file, an absolute URI may be given. In this case
64pandoc will fetch the content using HTTP:
66 pandoc -f html -t markdown http://www.fsf.org
68If multiple input files are given, `pandoc` will concatenate them all (with
69blank lines between them) before parsing. This feature is disabled for
70 binary input formats such as `EPUB` and `docx`.
72The format of the input and output can be specified explicitly using
73command-line options. The input format can be specified using the
74`-r/--read` or `-f/--from` options, the output format using the
75`-w/--write` or `-t/--to` options. Thus, to convert `hello.txt` from
76markdown to LaTeX, you could type:
78 pandoc -f markdown -t latex hello.txt
80To convert `hello.html` from html to markdown:
82 pandoc -f html -t markdown hello.html
84Supported output formats are listed below under the `-t/--to` option.
85Supported input formats are listed below under the `-f/--from` option. Note
86that the `rst`, `textile`, `latex`, and `html` readers are not complete;
87there are some constructs that they do not parse.
89If the input or output format is not specified explicitly, `pandoc`
90will attempt to guess it from the extensions of
91the input and output filenames. Thus, for example,
93 pandoc -o hello.tex hello.txt
95will convert `hello.txt` from markdown to LaTeX. If no output file
96is specified (so that output goes to *stdout*), or if the output file's
97extension is unknown, the output format will default to HTML.
98If no input file is specified (so that input comes from *stdin*), or
99if the input files' extensions are unknown, the input format will
100be assumed to be markdown unless explicitly specified.
102Pandoc uses the UTF-8 character encoding for both input and output.
103If your local character encoding is not UTF-8, you
104should pipe input and output through `iconv`:
106 iconv -t utf-8 input.txt | pandoc | iconv -f utf-8
108Note that in some output formats (such as HTML, LaTeX, ConTeXt,
109RTF, OPML, DocBook, and Texinfo), information about
110the character encoding is included in the document header, which
111will only be included if you use the `-s/--standalone` option.
116Earlier versions of pandoc came with a program, `markdown2pdf`, that
117used pandoc and pdflatex to produce a PDF. This is no longer needed,
118since `pandoc` can now produce `pdf` output itself. To produce a PDF, simply
119specify an output file with a `.pdf` extension. Pandoc will create a latex
120file and use pdflatex (or another engine, see `--latex-engine`) to convert it
123 pandoc test.txt -o test.pdf
125Production of a PDF requires that a LaTeX engine be installed (see
126`--latex-engine`, below), and assumes that the following LaTeX packages are
127available: `amssymb`, `amsmath`, `ifxetex`, `ifluatex`, `listings` (if the
128`--listings` option is used), `fancyvrb`, `longtable`, `booktabs`, `url`,
129`graphicx`, `hyperref`, `ulem`, `babel` (if the `lang` variable is set),
130`fontspec` (if `xelatex` or `lualatex` is used as the LaTeX engine), `xltxtra`
131and `xunicode` (if `xelatex` is used).
136A user who wants a drop-in replacement for `Markdown.pl` may create
137a symbolic link to the `pandoc` executable called `hsmarkdown`. When
138invoked under the name `hsmarkdown`, `pandoc` will behave as if
139invoked with `-f markdown_strict --email-obfuscation=references`,
140and all command-line options will be treated as regular arguments.
141However, this approach does not work under Cygwin, due to problems with
142its simulation of symbolic links.
144[Cygwin]: http://www.cygwin.com/
145[`iconv`]: http://www.gnu.org/software/libiconv/
146[CTAN]: http://www.ctan.org "Comprehensive TeX Archive Network"
147[TeX Live]: http://www.tug.org/texlive/
148[MacTeX]: http://www.tug.org/mactex/
156`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*
157: Specify input format. *FORMAT* can be `native` (native Haskell),
158 `json` (JSON version of native AST), `markdown` (pandoc's
159 extended markdown), `markdown_strict` (original unextended markdown),
160 `markdown_phpextra` (PHP Markdown Extra extended markdown),
161 `markdown_github` (github extended markdown),
162 `textile` (Textile), `rst` (reStructuredText), `html` (HTML),
163 `docbook` (DocBook), `t2t` (txt2tags), `docx` (docx), `epub` (EPUB),
164 `opml` (OPML), `org` (Emacs Org-mode), `mediawiki` (MediaWiki markup),
165 `twiki` (TWiki markup), `haddock` (Haddock markup), or `latex` (LaTeX).
166 If `+lhs` is appended to `markdown`, `rst`,
167 `latex`, or `html`, the input will be treated as literate Haskell
168 source: see [Literate Haskell support](#literate-haskell-support),
169 below. Markdown syntax extensions can be individually enabled or
170 disabled by appending `+EXTENSION` or `-EXTENSION` to the format
171 name. So, for example, `markdown_strict+footnotes+definition_lists`
172 is strict markdown with footnotes and definition lists enabled,
173 and `markdown-pipe_tables+hard_line_breaks` is pandoc's markdown
174 without pipe tables and with hard line breaks. See [Pandoc's
175 markdown](#pandocs-markdown), below, for a list of extensions and
178`-t` *FORMAT*, `-w` *FORMAT*, `--to=`*FORMAT*, `--write=`*FORMAT*
179: Specify output format. *FORMAT* can be `native` (native Haskell),
180 `json` (JSON version of native AST), `plain` (plain text),
181 `markdown` (pandoc's extended markdown), `markdown_strict` (original
182 unextended markdown), `markdown_phpextra` (PHP Markdown extra
183 extended markdown), `markdown_github` (github extended markdown),
184 `rst` (reStructuredText), `html` (XHTML 1), `html5` (HTML 5),
185 `latex` (LaTeX), `beamer` (LaTeX beamer slide show),
186 `context` (ConTeXt), `man` (groff man), `mediawiki` (MediaWiki markup),
187 `dokuwiki` (DokuWiki markup),
188 `textile` (Textile), `org` (Emacs Org-Mode), `texinfo` (GNU Texinfo),
189 `opml` (OPML), `docbook` (DocBook), `opendocument` (OpenDocument), `odt`
190 (OpenOffice text document), `docx` (Word docx), `haddock` (Haddock
191 markup), `rtf` (rich text format), `epub` (EPUB v2 book), `epub3`
192 (EPUB v3), `fb2` (FictionBook2 e-book), `asciidoc` (AsciiDoc),
193 `icml` (InDesign ICML), `slidy` (Slidy HTML and javascript slide show),
194 `slideous` (Slideous HTML and javascript slide show), `dzslides`
195 (DZSlides HTML5 + javascript slide show), `revealjs` (reveal.js
196 HTML5 + javascript slide show), `s5` (S5 HTML and javascript slide show),
197 or the path of a custom lua writer (see [Custom writers](#custom-writers),
198 below). Note that `odt`, `epub`, and `epub3` output will not be directed
199 to *stdout*; an output filename must be specified using the `-o/--output`
200 option. If `+lhs` is appended to `markdown`, `rst`, `latex`, `beamer`,
201 `html`, or `html5`, the output will be rendered as literate Haskell
202 source: see [Literate Haskell support](#literate-haskell-support), below.
203 Markdown syntax extensions can be individually enabled or disabled by
204 appending `+EXTENSION` or `-EXTENSION` to the format name, as described
207`-o` *FILE*, `--output=`*FILE*
208: Write output to *FILE* instead of *stdout*. If *FILE* is
209 `-`, output will go to *stdout*. (Exception: if the output
210 format is `odt`, `docx`, `epub`, or `epub3`, output to stdout is disabled.)
212`--data-dir=`*DIRECTORY*
213: Specify the user data directory to search for pandoc data files.
214 If this option is not specified, the default user data directory
215 will be used. This is
221 C:\Documents And Settings\USERNAME\Application Data\pandoc
225 C:\Users\USERNAME\AppData\Roaming\pandoc
227 in Windows 7. (You can find the default user data directory
228 on your system by looking at the output of `pandoc --version`.)
229 A `reference.odt`, `reference.docx`, `default.csl`,
230 `epub.css`, `templates`, `slidy`, `slideous`, or `s5` directory
231 placed in this directory will override pandoc's normal defaults.
234: Give verbose debugging output. Currently this only has an effect
247: Parse untranslatable HTML codes and LaTeX environments as raw HTML
248 or LaTeX, instead of ignoring them. Affects only HTML and LaTeX
249 input. Raw HTML can be printed in markdown, reStructuredText, HTML,
250 Slidy, Slideous, DZSlides, reveal.js, and S5 output; raw LaTeX
251 can be printed in markdown, reStructuredText, LaTeX, and ConTeXt output.
252 The default is for the readers to omit untranslatable HTML codes and
253 LaTeX environments. (The LaTeX reader does pass through untranslatable
254 LaTeX *commands*, even if `-R` is not specified.)
257: Produce typographically correct output, converting straight quotes
258 to curly quotes, `---` to em-dashes, `--` to en-dashes, and
259 `...` to ellipses. Nonbreaking spaces are inserted after certain
260 abbreviations, such as "Mr." (Note: This option is significant only when
261 the input format is `markdown`, `markdown_strict`, `textile` or `twiki`.
262 It is selected automatically when the input format is `textile` or the
263 output format is `latex` or `context`, unless `--no-tex-ligatures`
267: Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes: `-` before
268 a numeral is an en-dash, and `--` is an em-dash. This option is selected
269 automatically for `textile` input.
271`--base-header-level=`*NUMBER*
272: Specify the base level for headers (defaults to 1).
274`--indented-code-classes=`*CLASSES*
275: Specify classes to use for indented code blocks--for example,
276 `perl,numberLines` or `haskell`. Multiple classes may be separated
279`--default-image-extension=`*EXTENSION*
280: Specify a default extension to use when image paths/URLs have no
281 extension. This allows you to use the same source for formats that
282 require different kinds of images. Currently this option only affects
283 the markdown and LaTeX readers.
285`--filter=`*EXECUTABLE*
286: Specify an executable to be used as a filter transforming the
287 Pandoc AST after the input is parsed and before the output is
288 written. The executable should read JSON from stdin and write
289 JSON to stdout. The JSON must be formatted like pandoc's own
290 JSON input and output. The name of the output format will be
291 passed to the filter as the first argument. Hence,
293 pandoc --filter ./caps.py -t latex
297 pandoc -t json | ./caps.py latex | pandoc -f json -t latex
299 The latter form may be useful for debugging filters.
301 Filters may be written in any language. `Text.Pandoc.JSON`
302 exports `toJSONFilter` to facilitate writing filters in Haskell.
303 Those who would prefer to write filters in python can use the
304 module `pandocfilters`, installable from PyPI. See
305 <http://github.com/jgm/pandocfilters> for the module and several
306 examples. Note that the *EXECUTABLE* will be sought in the user's
307 `PATH`, and not in the working directory, if no directory is
308 provided. If you want to run a script in the working directory,
309 preface the filename with `./`.
311`-M` *KEY[=VAL]*, `--metadata=`*KEY[:VAL]*
312: Set the metadata field *KEY* to the value *VAL*. A value specified
313 on the command line overrides a value specified in the document.
314 Values will be parsed as YAML boolean or string values. If no value is
315 specified, the value will be treated as Boolean true. Like
316 `--variable`, `--metadata` causes template variables to be set.
317 But unlike `--variable`, `--metadata` affects the metadata of the
318 underlying document (which is accessible from filters and may be
319 printed in some output formats).
322: Normalize the document after reading: merge adjacent
323 `Str` or `Emph` elements, for example, and remove repeated `Space`s.
325`-p`, `--preserve-tabs`
326: Preserve tabs instead of converting them to spaces (the default).
327 Note that this will only affect tabs in literal code spans and code
328 blocks; tabs in regular text will be treated as spaces.
331: Specify the number of spaces per tab (default is 4).
333`--track-changes=`*accept|reject|all*
334: Specifies what to do with insertions and deletions produced by the MS
335 Word "track-changes" feature. *accept* (the default), inserts all
336 insertions, and ignores all deletions. *reject* inserts all
337 deletions and ignores insertions. *all* puts in both insertions
338 and deletions, wrapped in spans with `insertion` and `deletion`
339 classes, respectively. The author and time of change is
340 included. *all* is useful for scripting: only accepting changes
341 from a certain reviewer, say, or before a certain date. This
342 option only affects the docx reader.
344`--extract-media=`*DIR*
345: Extract images and other media contained in a docx or epub container
346 to the path *DIR*, creating it if necessary, and adjust the images
347 references in the document so they point to the extracted files.
348 This option only affects the docx and epub readers.
350General writer options
351----------------------
354: Produce output with an appropriate header and footer (e.g. a
355 standalone HTML, LaTeX, or RTF file, not a fragment). This option
356 is set automatically for `pdf`, `epub`, `epub3`, `fb2`, `docx`, and `odt`
360: Use *FILE* as a custom template for the generated document. Implies
361 `--standalone`. See [Templates](#templates) below for a description
362 of template syntax. If no extension is specified, an extension
363 corresponding to the writer will be added, so that `--template=special`
364 looks for `special.html` for HTML output. If the template is not
365 found, pandoc will search for it in the user data directory
366 (see `--data-dir`). If this option is not used, a default
367 template appropriate for the output format will be used (see
368 `-D/--print-default-template`).
370`-V` *KEY[=VAL]*, `--variable=`*KEY[:VAL]*
371: Set the template variable *KEY* to the value *VAL* when rendering the
372 document in standalone mode. This is generally only useful when the
373 `--template` option is used to specify a custom template, since
374 pandoc automatically sets the variables used in the default
375 templates. If no *VAL* is specified, the key will be given the
378`-D` *FORMAT*, `--print-default-template=`*FORMAT*
379: Print the default template for an output *FORMAT*. (See `-t`
380 for a list of possible *FORMAT*s.)
382`--print-default-data-file=`*FILE*
383: Print a default data file.
386: Disable text wrapping in output. By default, text is wrapped
387 appropriately for the output format.
390: Specify length of lines in characters (for text wrapping).
392`--toc`, `--table-of-contents`
393: Include an automatically generated table of contents (or, in
394 the case of `latex`, `context`, and `rst`, an instruction to create
395 one) in the output document. This option has no effect on `man`,
396 `docbook`, `slidy`, `slideous`, `s5`, `docx`, or `odt` output.
398`--toc-depth=`*NUMBER*
399: Specify the number of section levels to include in the table
400 of contents. The default is 3 (which means that level 1, 2, and 3
401 headers will be listed in the contents).
404: Disables syntax highlighting for code blocks and inlines, even when
405 a language attribute is given.
407`--highlight-style`=*STYLE*
408: Specifies the coloring style to be used in highlighted source code.
409 Options are `pygments` (the default), `kate`, `monochrome`,
410 `espresso`, `zenburn`, `haddock`, and `tango`.
412`-H` *FILE*, `--include-in-header=`*FILE*
413: Include contents of *FILE*, verbatim, at the end of the header.
414 This can be used, for example, to include special
415 CSS or javascript in HTML documents. This option can be used
416 repeatedly to include multiple files in the header. They will be
417 included in the order specified. Implies `--standalone`.
419`-B` *FILE*, `--include-before-body=`*FILE*
420: Include contents of *FILE*, verbatim, at the beginning of the
421 document body (e.g. after the `<body>` tag in HTML, or the
422 `\begin{document}` command in LaTeX). This can be used to include
423 navigation bars or banners in HTML documents. This option can be
424 used repeatedly to include multiple files. They will be included in
425 the order specified. Implies `--standalone`.
427`-A` *FILE*, `--include-after-body=`*FILE*
428: Include contents of *FILE*, verbatim, at the end of the document
429 body (before the `</body>` tag in HTML, or the
430 `\end{document}` command in LaTeX). This option can be be used
431 repeatedly to include multiple files. They will be included in the
432 order specified. Implies `--standalone`.
434Options affecting specific writers
435----------------------------------
438: Produce a standalone HTML file with no external dependencies, using
439 `data:` URIs to incorporate the contents of linked scripts, stylesheets,
440 images, and videos. The resulting file should be "self-contained,"
441 in the sense that it needs no external files and no net access to be
442 displayed properly by a browser. This option works only with HTML output
443 formats, including `html`, `html5`, `html+lhs`, `html5+lhs`, `s5`,
444 `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images, and
445 stylesheets at absolute URLs will be downloaded; those at relative URLs
446 will be sought relative to the working directory (if the first source
447 file is local) or relative to the base URL (if the first source
448 file is remote). `--self-contained` does not work with `--mathjax`.
451: Deprecated synonym for `--self-contained`.
454: Produce HTML5 instead of HTML4. This option has no effect for writers
455 other than `html`. (*Deprecated:* Use the `html5` output format instead.)
458: Use `<q>` tags for quotes in HTML.
461: Use only ascii characters in output. Currently supported only
462 for HTML output (which uses numerical entities instead of
463 UTF-8 when this option is selected).
466: Use reference-style links, rather than inline links, in writing markdown
467 or reStructuredText. By default inline links are used.
470: Use ATX style headers in markdown and asciidoc output. The default is
471 to use setext-style headers for levels 1-2, and then ATX headers.
474: Treat top-level headers as chapters in LaTeX, ConTeXt, and DocBook
475 output. When the LaTeX template uses the report, book, or
476 memoir class, this option is implied. If `beamer` is the output
477 format, top-level headers will become `\part{..}`.
479`-N`, `--number-sections`
480: Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.
481 By default, sections are not numbered. Sections with class
482 `unnumbered` will never be numbered, even if `--number-sections`
485`--number-offset`=*NUMBER[,NUMBER,...]*,
486: Offset for section headings in HTML output (ignored in other
487 output formats). The first number is added to the section number for
488 top-level headers, the second for second-level headers, and so on.
489 So, for example, if you want the first top-level header in your
490 document to be numbered "6", specify `--number-offset=5`.
491 If your document starts with a level-2 header which you want to
492 be numbered "1.5", specify `--number-offset=1,4`.
493 Offsets are 0 by default. Implies `--number-sections`.
496: Do not convert quotation marks, apostrophes, and dashes to
497 the TeX ligatures when writing LaTeX or ConTeXt. Instead, just
498 use literal unicode characters. This is needed for using advanced
499 OpenType features with XeLaTeX and LuaLaTeX. Note: normally
500 `--smart` is selected automatically for LaTeX and ConTeXt
501 output, but it must be specified explicitly if `--no-tex-ligatures`
502 is selected. If you use literal curly quotes, dashes, and ellipses
503 in your source, then you may want to use `--no-tex-ligatures`
507: Use listings package for LaTeX code blocks
510: Make list items in slide shows display incrementally (one by one).
511 The default is for lists to be displayed all at once.
513`--slide-level`=*NUMBER*
514: Specifies that headers with the specified level create
515 slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headers
516 above this level in the hierarchy are used to divide the
517 slide show into sections; headers below this level create
518 subheads within a slide. The default is to set the slide level
519 based on the contents of the document; see
520 [Structuring the slide show](#structuring-the-slide-show), below.
523: Wrap sections in `<div>` tags (or `<section>` tags in HTML5),
524 and attach identifiers to the enclosing `<div>` (or `<section>`)
525 rather than the header itself.
526 See [Section identifiers](#header-identifiers-in-html-latex-and-context), below.
528`--email-obfuscation=`*none|javascript|references*
529: Specify a method for obfuscating `mailto:` links in HTML documents.
530 *none* leaves `mailto:` links as they are. *javascript* obfuscates
531 them using javascript. *references* obfuscates them by printing their
532 letters as decimal or hexadecimal character references.
534`--id-prefix`=*STRING*
535: Specify a prefix to be added to all automatically generated identifiers
536 in HTML and DocBook output, and to footnote numbers in markdown output.
537 This is useful for preventing duplicate identifiers when generating
538 fragments to be included in other pages.
540`-T` *STRING*, `--title-prefix=`*STRING*
541: Specify *STRING* as a prefix at the beginning of the title
542 that appears in the HTML header (but not in the title as it
543 appears at the beginning of the HTML body). Implies
546`-c` *URL*, `--css=`*URL*
547: Link to a CSS style sheet. This option can be be used repeatedly to
548 include multiple files. They will be included in the order specified.
550`--reference-odt=`*FILE*
551: Use the specified file as a style reference in producing an ODT.
552 For best results, the reference ODT should be a modified version
553 of an ODT produced using pandoc. The contents of the reference ODT
554 are ignored, but its stylesheets are used in the new ODT. If no
555 reference ODT is specified on the command line, pandoc will look
556 for a file `reference.odt` in the user data directory (see
557 `--data-dir`). If this is not found either, sensible defaults will be
560`--reference-docx=`*FILE*
561: Use the specified file as a style reference in producing a docx file.
562 For best results, the reference docx should be a modified version
563 of a docx file produced using pandoc. The contents of the reference docx
564 are ignored, but its stylesheets and document properties (including
565 margins, page size, header, and footer) are used in the new docx. If no
566 reference docx is specified on the command line, pandoc will look
567 for a file `reference.docx` in the user data directory (see
568 `--data-dir`). If this is not found either, sensible defaults will be
569 used. The following styles are used by pandoc: [paragraph]
570 Normal, Compact, Title, Subtitle, Authors, Date, Abstract, Heading 1,
571 Heading 2, Heading 3, Heading 4, Heading 5, Block Quote, Definition Term,
572 Definition, Bibliography, Body Text, Table Caption, Image Caption;
573 [character] Default Paragraph Font, Body Text Char, Verbatim Char,
576`--epub-stylesheet=`*FILE*
577: Use the specified CSS file to style the EPUB. If no stylesheet
578 is specified, pandoc will look for a file `epub.css` in the
579 user data directory (see `--data-dir`). If it is not
580 found there, sensible defaults will be used.
582`--epub-cover-image=`*FILE*
583: Use the specified image as the EPUB cover. It is recommended
584 that the image be less than 1000px in width and height. Note that
585 in a markdown source document you can also specify `cover-image`
586 in a YAML metadata block (see [EPUB Metadata], below).
588`--epub-metadata=`*FILE*
589: Look in the specified XML file for metadata for the EPUB.
590 The file should contain a series of Dublin Core elements,
591 as documented at <http://dublincore.org/documents/dces/>.
594 <dc:rights>Creative Commons</dc:rights>
595 <dc:language>es-AR</dc:language>
597 By default, pandoc will include the following metadata elements:
598 `<dc:title>` (from the document title), `<dc:creator>` (from the
599 document authors), `<dc:date>` (from the document date, which should
600 be in [ISO 8601 format]), `<dc:language>` (from the `lang`
601 variable, or, if is not set, the locale), and `<dc:identifier
602 id="BookId">` (a randomly generated UUID). Any of these may be
603 overridden by elements in the metadata file.
605 Note: if the source document is markdown, a YAML metadata block
606 in the document can be used instead. See below under
609`--epub-embed-font=`*FILE*
610: Embed the specified font in the EPUB. This option can be repeated
611 to embed multiple fonts. Wildcards can also be used: for example,
612 `DejaVuSans-*.ttf`. However, if you use wildcards on the command
613 line, be sure to escape them or put the whole filename in single quotes,
614 to prevent them from being interpreted by the shell. To use the
615 embedded fonts, you will need to add declarations like the following
616 to your CSS (see `--epub-stylesheet`):
619 font-family: DejaVuSans;
622 src:url("DejaVuSans-Regular.ttf");
625 font-family: DejaVuSans;
628 src:url("DejaVuSans-Bold.ttf");
631 font-family: DejaVuSans;
634 src:url("DejaVuSans-Oblique.ttf");
637 font-family: DejaVuSans;
640 src:url("DejaVuSans-BoldOblique.ttf");
642 body { font-family: "DejaVuSans"; }
644`--epub-chapter-level=`*NUMBER*
645: Specify the header level at which to split the EPUB into separate
646 "chapter" files. The default is to split into chapters at level 1
647 headers. This option only affects the internal composition of the
648 EPUB, not the way chapters and sections are displayed to users. Some
649 readers may be slow if the chapter files are too large, so for large
650 documents with few level 1 headers, one might want to use a chapter
653`--latex-engine=`*pdflatex|lualatex|xelatex*
654: Use the specified LaTeX engine when producing PDF output.
655 The default is `pdflatex`. If the engine is not in your PATH,
656 the full path of the engine may be specified here.
661`--bibliography=`*FILE*
662: Set the `bibliography` field in the document's metadata to *FILE*,
663 overriding any value set in the metadata, and process citations
664 using `pandoc-citeproc`. (This is equivalent to
665 `--metadata bibliography=FILE --filter pandoc-citeproc`.)
668: Set the `csl` field in the document's metadata to *FILE*,
669 overriding any value set in the metadata. (This is equivalent to
670 `--metadata csl=FILE`.)
672`--citation-abbreviations=`*FILE*
673: Set the `citation-abbreviations` field in the document's metadata to
674 *FILE*, overriding any value set in the metadata. (This is equivalent to
675 `--metadata citation-abbreviations=FILE`.)
678: Use natbib for citations in LaTeX output. This option is not for use
679 with the `pandoc-citeproc` filter or with PDF output. It is intended for
680 use in producing a LaTeX file that can be processed with pdflatex and
684: Use biblatex for citations in LaTeX output. This option is not for use
685 with the `pandoc-citeproc` filter or with PDF output. It is intended for
686 use in producing a LaTeX file that can be processed with pdflatex and
689Math rendering in HTML
690----------------------
692`-m` [*URL*], `--latexmathml`[=*URL*]
693: Use the [LaTeXMathML] script to display embedded TeX math in HTML output.
694 To insert a link to a local copy of the `LaTeXMathML.js` script,
695 provide a *URL*. If no *URL* is provided, the contents of the
696 script will be inserted directly into the HTML header, preserving
697 portability at the price of efficiency. If you plan to use math on
698 several pages, it is much better to link to a copy of the script,
702: Convert TeX math to MathML (in `docbook` as well as `html` and `html5`).
703 In standalone `html` output, a small javascript (or a link to such a
704 script if a *URL* is supplied) will be inserted that allows the MathML to
705 be viewed on some browsers.
708: Use [jsMath] to display embedded TeX math in HTML output.
709 The *URL* should point to the jsMath load script (e.g.
710 `jsMath/easy/load.js`); if provided, it will be linked to in
711 the header of standalone HTML documents. If a *URL* is not provided,
712 no link to the jsMath load script will be inserted; it is then
713 up to the author to provide such a link in the HTML template.
716: Use [MathJax] to display embedded TeX math in HTML output.
717 The *URL* should point to the `MathJax.js` load script.
718 If a *URL* is not provided, a link to the MathJax CDN will
722: Enclose TeX math in `<eq>` tags in HTML output. These can then
723 be processed by [gladTeX] to produce links to images of the typeset
727: Render TeX math using the [mimeTeX] CGI script. If *URL* is not
728 specified, it is assumed that the script is at `/cgi-bin/mimetex.cgi`.
731: Render TeX formulas using an external script that converts TeX
732 formulas to images. The formula will be concatenated with the URL
733 provided. If *URL* is not specified, the Google Chart API will be used.
736: Use [KaTeX] to display embedded TeX math in HTML output.
737 The *URL* should point to the `katex.js` load script. If a *URL* is
738 not provided, a link to the KaTeX CDN will be inserted.
740`--katex-stylesheet=*URL*`
741: The *URL* should point to the `katex.css` stylesheet. If this option is
742 not specified, a link to the KaTeX CDN will be inserted. Note that this
743 option does not imply `--katex`.
745Options for wrapper scripts
746---------------------------
749: Print information about command-line arguments to *stdout*, then exit.
750 This option is intended primarily for use in wrapper scripts.
751 The first line of output contains the name of the output file specified
752 with the `-o` option, or `-` (for *stdout*) if no output file was
753 specified. The remaining lines contain the command-line arguments,
754 one per line, in the order they appear. These do not include regular
755 Pandoc options and their arguments, but do include any options appearing
756 after a `--` separator at the end of the line.
759: Ignore command-line arguments (for use in wrapper scripts).
760 Regular Pandoc options are not ignored. Thus, for example,
762 pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1
766 pandoc -o foo.html -s
768[LaTeXMathML]: http://math.etsu.edu/LaTeXMathML/
769[jsMath]: http://www.math.union.edu/~dpvc/jsmath/
770[MathJax]: http://www.mathjax.org/
771[gladTeX]: http://ans.hsh.no/home/mgg/gladtex/
772[mimeTeX]: http://www.forkosh.com/mimetex.html
773[CSL]: http://CitationStyles.org
778When the `-s/--standalone` option is used, pandoc uses a template to
779add header and footer material that is needed for a self-standing
780document. To see the default template that is used, just type
784where `FORMAT` is the name of the output format. A custom template
785can be specified using the `--template` option. You can also override
786the system default templates for a given output format `FORMAT`
787by putting a file `templates/default.FORMAT` in the user data
788directory (see `--data-dir`, above). *Exceptions:* For `odt` output,
789customize the `default.opendocument` template. For `pdf` output,
790customize the `default.latex` template.
792Templates may contain *variables*. Variable names are sequences of
793alphanumerics, `-`, and `_`, starting with a letter. A variable name
794surrounded by `$` signs will be replaced by its value. For example,
795the string `$title$` in
797 <title>$title$</title>
799will be replaced by the document title.
801To write a literal `$` in a template, use `$$`.
803Some variables are set automatically by pandoc. These vary somewhat
804depending on the output format, but include metadata fields (such
805as `title`, `author`, and `date`) as well as the following:
808: contents specified by `-H/--include-in-header` (may have multiple
812: non-null value if `--toc/--table-of-contents` was specified
815: contents specified by `-B/--include-before-body` (may have
819: contents specified by `-A/--include-after-body` (may have
826: language code for HTML or LaTeX documents
829: base URL for Slidy documents (defaults to
830 `http://www.w3.org/Talks/Tools/Slidy2`)
833: base URL for Slideous documents (defaults to `slideous`)
836: base URL for S5 documents (defaults to `s5/default`)
839: base URL for reveal.js documents (defaults to `reveal.js`)
842: reveal.js or LaTeX beamer theme
845: reveal.js transition
848: font size (10pt, 11pt, 12pt) for LaTeX documents
851: document class for LaTeX documents
854: option for LaTeX documentclass, e.g. `oneside`; may be repeated
858: options for LaTeX `geometry` class, e.g. `margin=1in`;
859 may be repeated for multiple options
862: adjusts line spacing (requires the `setspace` package)
865: font package to use for LaTeX documents (with pdflatex):
866 TeXLive has `bookman` (Bookman), `utopia` or `fourier` (Utopia),
867 `fouriernc` (New Century Schoolbook), `times` or `txfonts` (Times),
868 `mathpazo` or `pxfonts` or `mathpple` (Palatino),
869 `libertine` (Linux Libertine), `arev` (Arev Sans),
870 and the default `lmodern`, among others.
872`mainfont`, `sansfont`, `monofont`, `mathfont`
873: fonts for LaTeX documents (works only with xelatex
877: colortheme for LaTeX beamer documents
880: fonttheme for LaTeX beamer documents
883: color for internal links in LaTeX documents (`red`, `green`,
884 `magenta`, `cyan`, `blue`, `black`)
887: color for external links in LaTeX documents
890: color for citation links in LaTeX documents
893: causes links to be printed as footnotes in LaTeX documents
896: include table of contents in LaTeX documents
899: level of section to include in table of contents in LaTeX documents
902: include list of figures in LaTeX documents
905: include list of tables in LaTeX documents
908: bibliography style in LaTeX, when used with `--natbib`
911: bibliography files to use in LaTeX, with `--natbib` or `--biblatex`
914: section number in man pages
922Variables may be set at the command line using the `-V/--variable`
923option. Variables set in this way override metadata fields with
926Templates may contain conditionals. The syntax is as follows:
934This will include `X` in the template if `variable` has a non-null
935value; otherwise it will include `Y`. `X` and `Y` are placeholders for
936any valid template text, and may include interpolated variables or other
937conditionals. The `$else$` section may be omitted.
939When variables can have multiple values (for example, `author` in
940a multi-author document), you can use the `$for$` keyword:
943 <meta name="author" content="$author$" />
946You can optionally specify a separator to be used between
949 $for(author)$$author$$sep$, $endfor$
951A dot can be used to select a field of a variable that takes
952an object as its value. So, for example:
954 $author.name$ ($author.affiliation$)
956If you use custom templates, you may need to revise them as pandoc
957changes. We recommend tracking the changes in the default templates,
958and modifying your custom templates accordingly. An easy way to do this
959is to fork the pandoc-templates repository
960(<http://github.com/jgm/pandoc-templates>) and merge in changes after each
966Pandoc understands an extended and slightly revised version of
967John Gruber's [markdown] syntax. This document explains the syntax,
968noting differences from standard markdown. Except where noted, these
969differences can be suppressed by using the `markdown_strict` format instead
970of `markdown`. An extensions can be enabled by adding `+EXTENSION`
971to the format name and disabled by adding `-EXTENSION`. For example,
972`markdown_strict+footnotes` is strict markdown with footnotes
973enabled, while `markdown-footnotes-pipe_tables` is pandoc's
974markdown without footnotes or pipe tables.
979Markdown is designed to be easy to write, and, even more importantly,
982> A Markdown-formatted document should be publishable as-is, as plain
983> text, without looking like it's been marked up with tags or formatting
985> -- [John Gruber](http://daringfireball.net/projects/markdown/syntax#philosophy)
987This principle has guided pandoc's decisions in finding syntax for
988tables, footnotes, and other extensions.
990There is, however, one respect in which pandoc's aims are different
991from the original aims of markdown. Whereas markdown was originally
992designed with HTML generation in mind, pandoc is designed for multiple
993output formats. Thus, while pandoc allows the embedding of raw HTML,
994it discourages it, and provides other, non-HTMLish ways of representing
995important document elements like definition lists, tables, mathematics, and
1001A paragraph is one or more lines of text followed by one or more blank line.
1002Newlines are treated as spaces, so you can reflow your paragraphs as you like.
1003If you need a hard line break, put two or more spaces at the end of a line.
1005#### Extension: `escaped_line_breaks` ####
1007A backslash followed by a newline is also a hard line break.
1008Note: in multiline and grid table cells, this is the only way
1009to create a hard line break, since trailing spaces in the cells
1015There are two kinds of headers, Setext and atx.
1017### Setext-style headers ###
1019A setext-style header is a line of text "underlined" with a row of `=` signs
1020(for a level one header) or `-` signs (for a level two header):
1028The header text can contain inline formatting, such as emphasis (see
1029[Inline formatting](#inline-formatting), below).
1032### Atx-style headers ###
1034An Atx-style header consists of one to six `#` signs and a line of
1035text, optionally followed by any number of `#` signs. The number of
1036`#` signs at the beginning of the line is the header level:
1038 ## A level-two header
1040 ### A level-three header ###
1042As with setext-style headers, the header text can contain formatting:
1044 # A level-one header with a [link](/url) and *emphasis*
1046#### Extension: `blank_before_header` ####
1048Standard markdown syntax does not require a blank line before a header.
1049Pandoc does require this (except, of course, at the beginning of the
1050document). The reason for the requirement is that it is all too easy for a
1051`#` to end up at the beginning of a line by accident (perhaps through line
1052wrapping). Consider, for example:
1054 I like several of their flavors of ice cream:
1055 #22, for example, and #5.
1058### Header identifiers in HTML, LaTeX, and ConTeXt ###
1060#### Extension: `header_attributes` ####
1062Headers can be assigned attributes using this syntax at the end
1063of the line containing the header text:
1065 {#identifier .class .class key=value key=value}
1067Thus, for example, the following headers will all be assigned the identifier
1072 ## My header ## {#foo}
1074 My other header {#foo}
1077(This syntax is compatible with [PHP Markdown Extra].)
1079Note that although this syntax allows assignment of classes and key/value
1080attributes, writers generally don't use all of this information. Identifiers,
1081classes, and key/value attributes are used in HTML and HTML-based formats such
1082as EPUB and slidy. Identifiers are used for labels and link anchors in the
1083LaTeX, ConTeXt, Textile, and AsciiDoc writers.
1085Headers with the class `unnumbered` will not be numbered, even if
1086`--number-sections` is specified. A single hyphen (`-`) in an attribute
1087context is equivalent to `.unnumbered`, and preferable in non-English
1094 # My header {.unnumbered}
1096#### Extension: `auto_identifiers` ####
1098A header without an explicitly specified identifier will be
1099automatically assigned a unique identifier based on the header text.
1100To derive the identifier from the header text,
1102 - Remove all formatting, links, etc.
1103 - Remove all footnotes.
1104 - Remove all punctuation, except underscores, hyphens, and periods.
1105 - Replace all spaces and newlines with hyphens.
1106 - Convert all alphabetic characters to lowercase.
1107 - Remove everything up to the first letter (identifiers may
1108 not begin with a number or punctuation mark).
1109 - If nothing is left after this, use the identifier `section`.
1114 ------------------------------- ----------------------------
1115 Header identifiers in HTML `header-identifiers-in-html`
1116 *Dogs*?--in *my* house? `dogs--in-my-house`
1117 [HTML], [S5], or [RTF]? `html-s5-or-rtf`
1118 3. Applications `applications`
1121These rules should, in most cases, allow one to determine the identifier
1122from the header text. The exception is when several headers have the
1123same text; in this case, the first will get an identifier as described
1124above; the second will get the same identifier with `-1` appended; the
1125third with `-2`; and so on.
1127These identifiers are used to provide link targets in the table of
1128contents generated by the `--toc|--table-of-contents` option. They
1129also make it easy to provide links from one section of a document to
1130another. A link to this section, for example, might look like this:
1133 [header identifiers](#header-identifiers-in-html-latex-and-context).
1135Note, however, that this method of providing links to sections works
1136only in HTML, LaTeX, and ConTeXt formats.
1138If the `--section-divs` option is specified, then each section will
1139be wrapped in a `div` (or a `section`, if `--html5` was specified),
1140and the identifier will be attached to the enclosing `<div>`
1141(or `<section>`) tag rather than the header itself. This allows entire
1142sections to be manipulated using javascript or treated differently in
1145#### Extension: `implicit_header_references` ####
1147Pandoc behaves as if reference links have been defined for each header.
1150 [header identifiers](#header-identifiers-in-html)
1154 [header identifiers]
1158 [header identifiers][]
1162 [the section on header identifiers][header identifiers]
1164If there are multiple headers with identical text, the corresponding
1165reference will link to the first one only, and you will need to use explicit
1166links to link to the others, as described above.
1168Unlike regular reference links, these references are case-sensitive.
1170Note: if you have defined an explicit identifier for a header,
1171then implicit references to it will not work.
1176Markdown uses email conventions for quoting blocks of text.
1177A block quotation is one or more paragraphs or other block elements
1178(such as lists or headers), with each line preceded by a `>` character
1179and a space. (The `>` need not start at the left margin, but it should
1180not be indented more than three spaces.)
1182 > This is a block quote. This
1183 > paragraph has two lines.
1185 > 1. This is a list inside a block quote.
1188A "lazy" form, which requires the `>` character only on the first
1189line of each block, is also allowed:
1191 > This is a block quote. This
1192 paragraph has two lines.
1194 > 1. This is a list inside a block quote.
1197Among the block elements that can be contained in a block quote are
1198other block quotes. That is, block quotes can be nested:
1200 > This is a block quote.
1202 > > A block quote within a block quote.
1204#### Extension: `blank_before_blockquote` ####
1206Standard markdown syntax does not require a blank line before a block
1207quote. Pandoc does require this (except, of course, at the beginning of the
1208document). The reason for the requirement is that it is all too easy for a
1209`>` to end up at the beginning of a line by accident (perhaps through line
1210wrapping). So, unless the `markdown_strict` format is used, the following does
1211not produce a nested block quote in pandoc:
1213 > This is a block quote.
1217Verbatim (code) blocks
1218----------------------
1220### Indented code blocks ###
1222A block of text indented four spaces (or one tab) is treated as verbatim
1223text: that is, special characters do not trigger special formatting,
1224and all spaces and line breaks are preserved. For example,
1227 moveShip(5 * gravity, DOWN);
1230The initial (four space or one tab) indentation is not considered part
1231of the verbatim text, and is removed in the output.
1233Note: blank lines in the verbatim text need not begin with four spaces.
1236### Fenced code blocks ###
1238#### Extension: `fenced_code_blocks` ####
1240In addition to standard indented code blocks, Pandoc supports
1241*fenced* code blocks. These begin with a row of three or more
1242tildes (`~`) or backticks (`` ` ``) and end with a row of tildes or
1243backticks that must be at least as long as the starting row. Everything
1244between these lines is treated as code. No indentation is necessary:
1248 moveShip(5 * gravity, DOWN);
1252Like regular code blocks, fenced code blocks must be separated
1253from surrounding text by blank lines.
1255If the code itself contains a row of tildes or backticks, just use a longer
1256row of tildes or backticks at the start and end:
1260 code including tildes
1264#### Extension: `fenced_code_attributes` ####
1266Optionally, you may attach attributes to the code block using
1269 ~~~~ {#mycode .haskell .numberLines startFrom="100"}
1271 qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
1272 qsort (filter (>= x) xs)
1273 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1275Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and
1276`startFrom` is an attribute with value `100`. Some output formats can use this
1277information to do syntax highlighting. Currently, the only output formats
1278that uses this information are HTML and LaTeX. If highlighting is supported
1279for your output format and language, then the code block above will appear
1280highlighted, with numbered lines. (To see which languages are supported, do
1281`pandoc --version`.) Otherwise, the code block above will appear as follows:
1283 <pre id="mycode" class="haskell numberLines" startFrom="100">
1289A shortcut form can also be used for specifying the language of
1296This is equivalent to:
1302If the `fenced_code_attributes` extension is disabled, but
1303input contains class attribute(s) for the codeblock, the first
1304class attribute will be printed after the opening fence as a bare
1307To prevent all highlighting, use the `--no-highlight` flag.
1308To set the highlighting style, use `--highlight-style`.
1313#### Extension: `line_blocks` ####
1315A line block is a sequence of lines beginning with a vertical bar (`|`)
1316followed by a space. The division into lines will be preserved in
1317the output, as will any leading spaces; otherwise, the lines will
1318be formatted as markdown. This is useful for verse and addresses:
1320 | The limerick packs laughs anatomical
1321 | In space that is quite economical.
1322 | But the good ones I've seen
1323 | So seldom are clean
1324 | And the clean ones so seldom are comical
1327 | Berkeley, CA 94718
1329The lines can be hard-wrapped if needed, but the continuation
1330line must begin with a space.
1332 | The Right Honorable Most Venerable and Righteous Samuel L.
1335 | Berkeley, CA 94718
1337This syntax is borrowed from [reStructuredText].
1344A bullet list is a list of bulleted list items. A bulleted list
1345item begins with a bullet (`*`, `+`, or `-`). Here is a simple
1352This will produce a "compact" list. If you want a "loose" list, in which
1353each item is formatted as a paragraph, put spaces between the items:
1361The bullets need not be flush with the left margin; they may be
1362indented one, two, or three spaces. The bullet must be followed
1365List items look best if subsequent lines are flush with the first
1366line (after the bullet):
1372But markdown also allows a "lazy" format:
1378### The four-space rule ###
1380A list item may contain multiple paragraphs and other block-level
1381content. However, subsequent paragraphs must be preceded by a blank line
1382and indented four spaces or a tab. The list will look better if the first
1383paragraph is aligned with the rest:
1389 * Second paragraph. With a code block, which must be indented
1394List items may include other lists. In this case the preceding blank
1395line is optional. The nested list must be indented four spaces or
1408As noted above, markdown allows you to write list items "lazily," instead of
1409indenting continuation lines. However, if there are multiple paragraphs or
1410other blocks in a list item, the first line of each must be indented.
1412 + A lazy, lazy, list
1415 + Another one; this looks
1418 Second paragraph of second
1421**Note:** Although the four-space rule for continuation paragraphs
1422comes from the official [markdown syntax guide], the reference implementation,
1423`Markdown.pl`, does not follow it. So pandoc will give different results than
1424`Markdown.pl` when authors have indented continuation paragraphs fewer than
1427The [markdown syntax guide] is not explicit whether the four-space
1428rule applies to *all* block-level content in a list item; it only
1429mentions paragraphs and code blocks. But it implies that the rule
1430applies to all block-level content (including nested lists), and
1431pandoc interprets it that way.
1433 [markdown syntax guide]:
1434 http://daringfireball.net/projects/markdown/syntax#list
1436### Ordered lists ###
1438Ordered lists work just like bulleted lists, except that the items
1439begin with enumerators rather than bullets.
1441In standard markdown, enumerators are decimal numbers followed
1442by a period and a space. The numbers themselves are ignored, so
1443there is no difference between this list:
1455#### Extension: `fancy_lists` ####
1457Unlike standard markdown, Pandoc allows ordered list items to be marked
1458with uppercase and lowercase letters and roman numerals, in addition to
1459arabic numerals. List markers may be enclosed in parentheses or followed by a
1460single right-parentheses or period. They must be separated from the
1461text that follows by at least one space, and, if the list marker is a
1462capital letter with a period, by at least two spaces.[^2]
1464[^2]: The point of this rule is to ensure that normal paragraphs
1465 starting with people's initials, like
1467 B. Russell was an English philosopher.
1469 do not get treated as list items.
1471 This rule will not prevent
1475 from being interpreted as a list item. In this case, a backslash
1480The `fancy_lists` extension also allows '`#`' to be used as an
1481ordered list marker in place of a numeral:
1486#### Extension: `startnum` ####
1488Pandoc also pays attention to the type of list marker used, and to the
1489starting number, and both of these are preserved where possible in the
1490output format. Thus, the following yields a list with numbers followed
1491by a single parenthesis, starting with 9, and a sublist with lowercase
1501Pandoc will start a new list each time a different type of list
1502marker is used. So, the following will create three lists:
1509If default list markers are desired, use `#.`:
1516### Definition lists ###
1518#### Extension: `definition_lists` ####
1520Pandoc supports definition lists, using the syntax of
1521[PHP Markdown Extra] with some extensions.[^3]
1527 Term 2 with *inline markup*
1531 { some code, part of Definition 2 }
1533 Third paragraph of definition 2.
1535Each term must fit on one line, which may optionally be followed by
1536a blank line, and must be followed by one or more definitions.
1537A definition begins with a colon or tilde, which may be indented one
1540A term may have multiple definitions, and each definition may consist of one or
1541more block elements (paragraph, code block, list, etc.), each indented four
1542spaces or one tab stop. The body of the definition (including the first line,
1543aside from the colon or tilde) should be indented four spaces. However,
1544as with other markdown lists, you can "lazily" omit indentation except
1545at the beginning of a paragraph or other block element:
1550 with lazy continuation.
1552 Second paragraph of the definition.
1554If you leave space before the definition (as in the example above),
1555the text of the definition will be treated as a paragraph. In some
1556output formats, this will mean greater spacing between term/definition
1557pairs. For a more compact definition list, omit the space before the
1567Note that space between items in a definition list is required.
1568(A variant that loosens this requirement, but disallows "lazy"
1569hard wrapping, can be activated with `compact_definition_lists`: see
1570[Non-pandoc extensions](#non-pandoc-extensions), below.)
1572[^3]: I have been influenced by the suggestions of [David Wheeler](http://www.justatheory.com/computers/markup/modest-markdown-proposal.html).
1574[PHP Markdown Extra]: http://www.michelf.com/projects/php-markdown/extra/
1577### Numbered example lists ###
1579#### Extension: `example_lists` ####
1581The special list marker `@` can be used for sequentially numbered
1582examples. The first list item with a `@` marker will be numbered '1',
1583the next '2', and so on, throughout the document. The numbered examples
1584need not occur in a single list; each new list using `@` will take up
1585where the last stopped. So, for example:
1587 (@) My first example will be numbered (1).
1588 (@) My second example will be numbered (2).
1590 Explanation of examples.
1592 (@) My third example will be numbered (3).
1594Numbered examples can be labeled and referred to elsewhere in the
1597 (@good) This is a good example.
1599 As (@good) illustrates, ...
1601The label can be any string of alphanumeric characters, underscores,
1605### Compact and loose lists ###
1607Pandoc behaves differently from `Markdown.pl` on some "edge
1608cases" involving lists. Consider this source:
1618Pandoc transforms this into a "compact list" (with no `<p>` tags around
1619"First", "Second", or "Third"), while markdown puts `<p>` tags around
1620"Second" and "Third" (but not "First"), because of the blank space
1621around "Third". Pandoc follows a simple rule: if the text is followed by
1622a blank line, it is treated as a paragraph. Since "Second" is followed
1623by a list, and not a blank line, it isn't treated as a paragraph. The
1624fact that the list is followed by a blank line is irrelevant. (Note:
1625Pandoc works this way even when the `markdown_strict` format is specified. This
1626behavior is consistent with the official markdown syntax description,
1627even though it is different from that of `Markdown.pl`.)
1630### Ending a list ###
1632What if you want to put an indented code block after a list?
1639Trouble! Here pandoc (like other markdown implementations) will treat
1640`{ my code block }` as the second paragraph of item two, and not as
1643To "cut off" the list after item two, you can insert some non-indented
1644content, like an HTML comment, which won't produce visible output in
1650 <!-- end of list -->
1654You can use the same trick if you want two consecutive lists instead
1670A line containing a row of three or more `*`, `-`, or `_` characters
1671(optionally separated by spaces) produces a horizontal rule:
1681Four kinds of tables may be used. The first three kinds presuppose the use of
1682a fixed-width font, such as Courier. The fourth kind can be used with
1683proportionally spaced fonts, as it does not require lining up columns.
1685#### Extension: `table_captions` ####
1687A caption may optionally be provided with all 4 kinds of tables (as
1688illustrated in the examples below). A caption is a paragraph beginning
1689with the string `Table:` (or just `:`), which will be stripped off.
1690It may appear either before or after the table.
1692#### Extension: `simple_tables` ####
1694Simple tables look like this:
1696 Right Left Center Default
1697 ------- ------ ---------- -------
1702 Table: Demonstration of simple table syntax.
1704The headers and table rows must each fit on one line. Column
1705alignments are determined by the position of the header text relative
1706to the dashed line below it:[^4]
1708 - If the dashed line is flush with the header text on the right side
1709 but extends beyond it on the left, the column is right-aligned.
1710 - If the dashed line is flush with the header text on the left side
1711 but extends beyond it on the right, the column is left-aligned.
1712 - If the dashed line extends beyond the header text on both sides,
1713 the column is centered.
1714 - If the dashed line is flush with the header text on both sides,
1715 the default alignment is used (in most cases, this will be left).
1717[^4]: This scheme is due to Michel Fortin, who proposed it on the
1718 [Markdown discussion list](http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html).
1720The table must end with a blank line, or a line of dashes followed by
1723The column headers may be omitted, provided a dashed line is used
1724to end the table. For example:
1726 ------- ------ ---------- -------
1730 ------- ------ ---------- -------
1732When headers are omitted, column alignments are determined on the basis
1733of the first line of the table body. So, in the tables above, the columns
1734would be right, left, center, and right aligned, respectively.
1736#### Extension: `multiline_tables` ####
1738Multiline tables allow headers and table rows to span multiple lines
1739of text (but cells that span multiple columns or rows of the table are
1740not supported). Here is an example:
1742 -------------------------------------------------------------
1743 Centered Default Right Left
1744 Header Aligned Aligned Aligned
1745 ----------- ------- --------------- -------------------------
1746 First row 12.0 Example of a row that
1747 spans multiple lines.
1749 Second row 5.0 Here's another one. Note
1750 the blank line between
1752 -------------------------------------------------------------
1754 Table: Here's the caption. It, too, may span
1757These work like simple tables, but with the following differences:
1759 - They must begin with a row of dashes, before the header text
1760 (unless the headers are omitted).
1761 - They must end with a row of dashes, then a blank line.
1762 - The rows must be separated by blank lines.
1764In multiline tables, the table parser pays attention to the widths of
1765the columns, and the writers try to reproduce these relative widths in
1766the output. So, if you find that one of the columns is too narrow in the
1767output, try widening it in the markdown source.
1769Headers may be omitted in multiline tables as well as simple tables:
1771 ----------- ------- --------------- -------------------------
1772 First row 12.0 Example of a row that
1773 spans multiple lines.
1775 Second row 5.0 Here's another one. Note
1776 the blank line between
1778 ----------- ------- --------------- -------------------------
1780 : Here's a multiline table without headers.
1782It is possible for a multiline table to have just one row, but the row
1783should be followed by a blank line (and then the row of dashes that ends
1784the table), or the table may be interpreted as a simple table.
1786#### Extension: `grid_tables` ####
1788Grid tables look like this:
1790 : Sample grid table.
1792 +---------------+---------------+--------------------+
1793 | Fruit | Price | Advantages |
1794 +===============+===============+====================+
1795 | Bananas | $1.34 | - built-in wrapper |
1796 | | | - bright color |
1797 +---------------+---------------+--------------------+
1798 | Oranges | $2.10 | - cures scurvy |
1800 +---------------+---------------+--------------------+
1802The row of `=`s separates the header from the table body, and can be
1803omitted for a headerless table. The cells of grid tables may contain
1804arbitrary block elements (multiple paragraphs, code blocks, lists,
1805etc.). Alignments are not supported, nor are cells that span multiple
1806columns or rows. Grid tables can be created easily using [Emacs table mode].
1808 [Emacs table mode]: http://table.sourceforge.net/
1810#### Extension: `pipe_tables` ####
1812Pipe tables look like this:
1814 | Right | Left | Default | Center |
1815 |------:|:-----|---------|:------:|
1816 | 12 | 12 | 12 | 12 |
1817 | 123 | 123 | 123 | 123 |
1820 : Demonstration of pipe table syntax.
1822The syntax is [the same as in PHP markdown extra]. The beginning and
1823ending pipe characters are optional, but pipes are required between all
1824columns. The colons indicate column alignment as shown. The header
1825can be omitted, but the horizontal line must still be included, as
1826it defines column alignments.
1828Since the pipes indicate column boundaries, columns need not be vertically
1829aligned, as they are in the above example. So, this is a perfectly
1830legal (though ugly) pipe table:
1838The cells of pipe tables cannot contain block elements like paragraphs
1839and lists, and cannot span multiple lines. Note also that in LaTeX/PDF
1840output, the cells produced by pipe tables will not wrap, since there
1841is no information available about relative widths. If you want content
1842to wrap within cells, use multiline or grid tables.
1844 [the same as in PHP markdown extra]:
1845 http://michelf.ca/projects/php-markdown/extra/#table
1847Note: Pandoc also recognizes pipe tables of the following
1848form, as can produced by Emacs' orgtbl-mode:
1855The difference is that `+` is used instead of `|`. Other orgtbl features
1856are not supported. In particular, to get non-default column alignment,
1857you'll need to add colons as above.
1862#### Extension: `pandoc_title_block` ####
1864If the file begins with a title block
1867 % author(s) (separated by semicolons)
1870it will be parsed as bibliographic information, not regular text. (It
1871will be used, for example, in the title of standalone LaTeX or HTML
1872output.) The block may contain just a title, a title and an author,
1873or all three elements. If you want to include an author but no
1874title, or a title and a date but no author, you need a blank line:
1883The title may occupy multiple lines, but continuation lines must
1884begin with leading space, thus:
1889If a document has multiple authors, the authors may be put on
1890separate lines with leading space, or separated by semicolons, or
1891both. So, all of the following are equivalent:
1896 % Author One; Author Two
1901The date must fit on one line.
1903All three metadata fields may contain standard inline formatting
1904(italics, links, footnotes, etc.).
1906Title blocks will always be parsed, but they will affect the output only
1907when the `--standalone` (`-s`) option is chosen. In HTML output, titles
1908will appear twice: once in the document head -- this is the title that
1909will appear at the top of the window in a browser -- and once at the
1910beginning of the document body. The title in the document head can have
1911an optional prefix attached (`--title-prefix` or `-T` option). The title
1912in the body appears as an H1 element with class "title", so it can be
1913suppressed or reformatted with CSS. If a title prefix is specified with
1914`-T` and no title block appears in the document, the title prefix will
1915be used by itself as the HTML title.
1917The man page writer extracts a title, man page section number, and
1918other header and footer information from the title line. The title
1919is assumed to be the first word on the title line, which may optionally
1920end with a (single-digit) section number in parentheses. (There should
1921be no space between the title and the parentheses.) Anything after
1922this is assumed to be additional footer and header text. A single pipe
1923character (`|`) should be used to separate the footer text from the header
1928will yield a man page with the title `PANDOC` and section 1.
1930 % PANDOC(1) Pandoc User Manuals
1932will also have "Pandoc User Manuals" in the footer.
1934 % PANDOC(1) Pandoc User Manuals | Version 4.0
1936will also have "Version 4.0" in the header.
1938#### Extension: `yaml_metadata_block` ####
1940A YAML metadata block is a valid YAML object, delimited by a line of three
1941hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
1942(`...`) at the bottom. A YAML metadata block may occur anywhere in the
1943document, but if it is not at the beginning, it must be preceded by a blank
1944line. (Note that, because of the way pandoc concatenates input files when
1945several are provided, you may also keep the metadata in a separate YAML file
1946and pass it to pandoc as an argument, along with your markdown files:
1948 pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
1950Just be sure that the YAML file begins with `---` and ends with `---` or
1953Metadata will be taken from the fields of the YAML object and added to any
1954existing document metadata. Metadata can contain lists and objects (nested
1955arbitrarily), but all string scalars will be interpreted as markdown. Fields
1956with names ending in an underscore will be ignored by pandoc. (They may be
1957given a role by external processors.)
1959A document may contain multiple metadata blocks. The metadata fields will
1960be combined through a *left-biased union*: if two metadata blocks attempt
1961to set the same field, the value from the first block will be taken.
1963When pandoc is used with `-t markdown` to create a markdown document,
1964a YAML metadata block will be produced only if the `-s/--standalone`
1965option is used. All of the metadata will appear in a single block
1966at the beginning of the document.
1968Note that YAML escaping rules must be followed. Thus, for example,
1969if a title contains a colon, it must be quoted. The pipe character
1970(`|`) can be used to begin an indented block that will be interpreted
1971literally, without need for escaping. This form is necessary
1972when the field contains blank lines:
1975 title: 'This is the title: it contains a colon'
1978 affiliation: University of Somewhere
1980 affiliation: University of Nowhere
1981 tags: [nothing, nothingness]
1983 This is the abstract.
1985 It consists of two paragraphs.
1988Template variables will be set automatically from the metadata. Thus, for
1989example, in writing HTML, the variable `abstract` will be set to the HTML
1990equivalent of the markdown in the `abstract` field:
1992 <p>This is the abstract.</p>
1993 <p>It consists of two paragraphs.</p>
1995Note: The `author` variable in the default templates expects a simple list or
1996string. To use the structured authors in the example, you would need a
1997custom template. For example:
2001 $author.name$$if(author.affiliation)$ ($author.affiliation$)$endif$
2011#### Extension: `all_symbols_escapable` ####
2013Except inside a code block or inline code, any punctuation or space
2014character preceded by a backslash will be treated literally, even if it
2015would normally indicate formatting. Thus, for example, if one writes
2025 <strong>hello</strong>
2027This rule is easier to remember than standard markdown's rule,
2028which allows only the following characters to be backslash-escaped:
2032(However, if the `markdown_strict` format is used, the standard markdown rule
2035A backslash-escaped space is parsed as a nonbreaking space. It will
2036appear in TeX output as `~` and in HTML and XML as `\ ` or
2039A backslash-escaped newline (i.e. a backslash occurring at the end of
2040a line) is parsed as a hard line break. It will appear in TeX output as
2041`\\` and in HTML as `<br />`. This is a nice alternative to
2042markdown's "invisible" way of indicating hard line breaks using
2043two trailing spaces on a line.
2045Backslash escapes do not work in verbatim contexts.
2052If the `--smart` option is specified, pandoc will produce typographically
2053correct output, converting straight quotes to curly quotes, `---` to
2054em-dashes, `--` to en-dashes, and `...` to ellipses. Nonbreaking spaces
2055are inserted after certain abbreviations, such as "Mr."
2057Note: if your LaTeX template uses the `csquotes` package, pandoc will
2058detect automatically this and use `\enquote{...}` for quoted text.
2065To *emphasize* some text, surround it with `*`s or `_`, like this:
2067 This text is _emphasized with underscores_, and this
2068 is *emphasized with asterisks*.
2070Double `*` or `_` produces **strong emphasis**:
2072 This is **strong emphasis** and __with underscores__.
2074A `*` or `_` character surrounded by spaces, or backslash-escaped,
2075will not trigger emphasis:
2077 This is * not emphasized *, and \*neither is this\*.
2079#### Extension: `intraword_underscores` ####
2081Because `_` is sometimes used inside words and identifiers,
2082pandoc does not interpret a `_` surrounded by alphanumeric
2083characters as an emphasis marker. If you want to emphasize
2084just part of a word, use `*`:
2086 feas*ible*, not feas*able*.
2091#### Extension: `strikeout` ####
2093To strikeout a section of text with a horizontal line, begin and end it
2094with `~~`. Thus, for example,
2096 This ~~is deleted text.~~
2099### Superscripts and subscripts ###
2101#### Extension: `superscript`, `subscript` ####
2103Superscripts may be written by surrounding the superscripted text by `^`
2104characters; subscripts may be written by surrounding the subscripted
2105text by `~` characters. Thus, for example,
2107 H~2~O is a liquid. 2^10^ is 1024.
2109If the superscripted or subscripted text contains spaces, these spaces
2110must be escaped with backslashes. (This is to prevent accidental
2111superscripting and subscripting through the ordinary use of `~` and `^`.)
2112Thus, if you want the letter P with 'a cat' in subscripts, use
2113`P~a\ cat~`, not `P~a cat~`.
2118To make a short span of text verbatim, put it inside backticks:
2120 What is the difference between `>>=` and `>>`?
2122If the verbatim text includes a backtick, use double backticks:
2124 Here is a literal backtick `` ` ``.
2126(The spaces after the opening backticks and before the closing
2127backticks will be ignored.)
2129The general rule is that a verbatim span starts with a string
2130of consecutive backticks (optionally followed by a space)
2131and ends with a string of the same number of backticks (optionally
2132preceded by a space).
2134Note that backslash-escapes (and other markdown constructs) do not
2135work in verbatim contexts:
2137 This is a backslash followed by an asterisk: `\*`.
2139#### Extension: `inline_code_attributes` ####
2141Attributes can be attached to verbatim text, just as with
2142[fenced code blocks](#fenced-code-blocks):
2148To write small caps, you can use an HTML span tag:
2150 <span style="font-variant:small-caps;">Small caps</span>
2152(The semicolon is optional and there may be space after the
2153colon.) This will work in all output formats that support small caps.
2158#### Extension: `tex_math_dollars` ####
2160Anything between two `$` characters will be treated as TeX math. The
2161opening `$` must have a non-space character immediately to its right,
2162while the closing `$` must have a non-space character immediately to its
2163left, and must not be followed immediately by a digit. Thus,
2164`$20,000 and $30,000` won't parse as math. If for some reason
2165you need to enclose text in literal `$` characters, backslash-escape
2166them and they won't be treated as math delimiters.
2168TeX math will be printed in all output formats. How it is rendered
2169depends on the output format:
2171Markdown, LaTeX, Org-Mode, ConTeXt
2172 ~ It will appear verbatim between `$` characters.
2175 ~ It will be rendered using an interpreted text role `:math:`, as described
2176 [here](http://docutils.sourceforge.net/docs/ref/rst/roles.html#math)
2179 ~ It will be rendered as `latexmath:[...]`.
2182 ~ It will be rendered inside a `@math` command.
2185 ~ It will be rendered verbatim without `$`'s.
2188 ~ It will be rendered inside `<math>` tags.
2191 ~ It will be rendered inside `<span class="math">` tags.
2193RTF, OpenDocument, ODT
2194 ~ It will be rendered, if possible, using unicode characters,
2195 and will otherwise appear verbatim.
2198 ~ If the `--mathml` flag is used, it will be rendered using mathml
2199 in an `inlineequation` or `informalequation` tag. Otherwise it
2200 will be rendered, if possible, using unicode characters.
2203 ~ It will be rendered using OMML math markup.
2206 ~ If the `--webtex` option is used, formulas are rendered as images
2207 using Google Charts or other compatible web service, downloaded
2208 and embedded in the e-book. Otherwise, they will appear verbatim.
2210HTML, Slidy, DZSlides, S5, EPUB
2211 ~ The way math is rendered in HTML will depend on the
2212 command-line options selected:
2214 1. The default is to render TeX math as far as possible using unicode
2215 characters, as with RTF, DocBook, and OpenDocument output. Formulas
2216 are put inside a `span` with `class="math"`, so that they may be
2217 styled differently from the surrounding text if needed.
2219 2. If the `--latexmathml` option is used, TeX math will be displayed
2220 between `$` or `$$` characters and put in `<span>` tags with class `LaTeX`.
2221 The [LaTeXMathML] script will be used to render it as formulas.
2222 (This trick does not work in all browsers, but it works in Firefox.
2223 In browsers that do not support LaTeXMathML, TeX math will appear
2224 verbatim between `$` characters.)
2226 3. If the `--jsmath` option is used, TeX math will be put inside
2227 `<span>` tags (for inline math) or `<div>` tags (for display math)
2228 with class `math`. The [jsMath] script will be used to render
2231 4. If the `--mimetex` option is used, the [mimeTeX] CGI script will
2232 be called to generate images for each TeX formula. This should
2233 work in all browsers. The `--mimetex` option takes an optional URL
2234 as argument. If no URL is specified, it will be assumed that the
2235 mimeTeX CGI script is at `/cgi-bin/mimetex.cgi`.
2237 5. If the `--gladtex` option is used, TeX formulas will be enclosed
2238 in `<eq>` tags in the HTML output. The resulting `htex` file may then
2239 be processed by [gladTeX], which will produce image files for each
2240 formula and an `html` file with links to these images. So, the
2243 pandoc -s --gladtex myfile.txt -o myfile.htex
2244 gladtex -d myfile-images myfile.htex
2245 # produces myfile.html and images in myfile-images
2247 6. If the `--webtex` option is used, TeX formulas will be converted
2248 to `<img>` tags that link to an external script that converts
2249 formulas to images. The formula will be URL-encoded and concatenated
2250 with the URL provided. If no URL is specified, the Google Chart
2251 API will be used (`http://chart.apis.google.com/chart?cht=tx&chl=`).
2253 7. If the `--mathjax` option is used, TeX math will be displayed
2254 between `\(...\)` (for inline math) or `\[...\]` (for display
2255 math) and put in `<span>` tags with class `math`.
2256 The [MathJax] script will be used to render it as formulas.
2261#### Extension: `raw_html` ####
2263Markdown allows you to insert raw HTML (or DocBook) anywhere in a document
2264(except verbatim contexts, where `<`, `>`, and `&` are interpreted
2265literally). (Technically this is not an extension, since standard
2266markdown allows it, but it has been made an extension so that it can
2267be disabled if desired.)
2269The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
2270DZSlides, EPUB, Markdown, and Textile output, and suppressed in other
2273#### Extension: `markdown_in_html_blocks` ####
2275Standard markdown allows you to include HTML "blocks": blocks
2276of HTML between balanced tags that are separated from the surrounding text
2277with blank lines, and start and end at the left margin. Within
2278these blocks, everything is interpreted as HTML, not markdown;
2279so (for example), `*` does not signify emphasis.
2281Pandoc behaves this way when the `markdown_strict` format is used; but
2282by default, pandoc interprets material between HTML block tags as markdown.
2283Thus, for example, Pandoc will turn
2288 <td>[a link](http://google.com)</td>
2296 <td><em>one</em></td>
2297 <td><a href="http://google.com">a link</a></td>
2301whereas `Markdown.pl` will preserve it as is.
2303There is one exception to this rule: text between `<script>` and
2304`<style>` tags is not interpreted as markdown.
2306This departure from standard markdown should make it easier to mix
2307markdown with HTML block elements. For example, one can surround
2308a block of markdown text with `<div>` tags without preventing it
2309from being interpreted as markdown.
2311#### Extension: `native_divs` ####
2313Use native pandoc `Div` blocks for content inside `<div>` tags.
2314For the most part this should give the same output as
2315`markdown_in_html_blocks`, but it makes it easier to write pandoc
2316filters to manipulate groups of blocks.
2318#### Extension: `native_spans` ####
2320Use native pandoc `Span` blocks for content inside `<span>` tags.
2321For the most part this should give the same output as `raw_html`,
2322but it makes it easier to write pandoc filters to manipulate groups
2328#### Extension: `raw_tex` ####
2330In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be
2331included in a document. Inline TeX commands will be preserved and passed
2332unchanged to the LaTeX and ConTeXt writers. Thus, for example, you can use
2333LaTeX to include BibTeX citations:
2335 This result was proved in \cite{jones.1967}.
2337Note that in LaTeX environments, like
2339 \begin{tabular}{|l|l|}\hline
2340 Age & Frequency \\ \hline
2343 36--45 & 22 \\ \hline
2346the material between the begin and end tags will be interpreted as raw
2347LaTeX, not as markdown.
2349Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
2355#### Extension: `latex_macros` ####
2357For output formats other than LaTeX, pandoc will parse LaTeX `\newcommand` and
2358`\renewcommand` definitions and apply the resulting macros to all LaTeX
2359math. So, for example, the following will work in all output formats,
2362 \newcommand{\tuple}[1]{\langle #1 \rangle}
2366In LaTeX output, the `\newcommand` definition will simply be passed
2367unchanged to the output.
2373Markdown allows links to be specified in several ways.
2375### Automatic links ###
2377If you enclose a URL or email address in pointy brackets, it
2381 <sam@green.eggs.ham>
2385An inline link consists of the link text in square brackets,
2386followed by the URL in parentheses. (Optionally, the URL can
2387be followed by a link title, in quotes.)
2389 This is an [inline link](/url), and here's [one with
2390 a title](http://fsf.org "click here for a good time!").
2392There can be no space between the bracketed part and the parenthesized part.
2393The link text can contain formatting (such as emphasis), but the title cannot.
2395Email addresses in inline links are not autodetected, so they have to be
2396prefixed with `mailto`:
2398 [Write me!](mailto:sam@green.eggs.ham)
2400### Reference links ###
2402An *explicit* reference link has two parts, the link itself and the link
2403definition, which may occur elsewhere in the document (either
2404before or after the link).
2406The link consists of link text in square brackets, followed by a label in
2407square brackets. (There can be space between the two.) The link definition
2408consists of the bracketed label, followed by a colon and a space, followed by
2409the URL, and optionally (after a space) a link title either in quotes or in
2410parentheses. The label must not be parseable as a citation (assuming
2411the `citations` extension is enabled): citations take precedence over
2414Here are some examples:
2416 [my label 1]: /foo/bar.html "My title, optional"
2418 [my label 3]: http://fsf.org (The free software foundation)
2419 [my label 4]: /bar#special 'A title in single quotes'
2421The URL may optionally be surrounded by angle brackets:
2423 [my label 5]: <http://foo.bar.baz>
2425The title may go on the next line:
2427 [my label 3]: http://fsf.org
2428 "The free software foundation"
2430Note that link labels are not case sensitive. So, this will work:
2432 Here is [my link][FOO]
2436In an *implicit* reference link, the second pair of brackets is
2437empty, or omitted entirely:
2439 See [my website][], or [my website].
2441 [my website]: http://foo.bar.baz
2443Note: In `Markdown.pl` and most other markdown implementations,
2444reference link definitions cannot occur in nested constructions
2445such as list items or block quotes. Pandoc lifts this arbitrary
2446seeming restriction. So the following is fine in pandoc, though
2447not in most other implementations:
2453### Internal links ###
2455To link to another section of the same document, use the automatically
2456generated identifier (see [Header identifiers in HTML, LaTeX, and
2457ConTeXt](#header-identifiers-in-html-latex-and-context), below).
2460 See the [Introduction](#introduction).
2464 See the [Introduction].
2466 [Introduction]: #introduction
2468Internal links are currently supported for HTML formats (including
2469HTML slide shows and EPUB), LaTeX, and ConTeXt.
2474A link immediately preceded by a `!` will be treated as an image.
2475The link text will be used as the image's alt text:
2477 
2481 [movie reel]: movie.gif
2483#### Extension: `implicit_figures` ####
2485An image occurring by itself in a paragraph will be rendered as
2486a figure with a caption.[^5] (In LaTeX, a figure environment will be
2487used; in HTML, the image will be placed in a `div` with class
2488`figure`, together with a caption in a `p` with class `caption`.)
2489The image's alt text will be used as the caption.
2491 
2493[^5]: This feature is not yet implemented for RTF, OpenDocument, or
2494 ODT. In those formats, you'll just get an image in a paragraph by
2495 itself, with no caption.
2497If you just want a regular inline image, just make sure it is not
2498the only thing in the paragraph. One way to do this is to insert a
2499nonbreaking space after the image:
2501 \
2507#### Extension: `footnotes` ####
2509Pandoc's markdown allows footnotes, using the following syntax:
2511 Here is a footnote reference,[^1] and another.[^longnote]
2513 [^1]: Here is the footnote.
2515 [^longnote]: Here's one with multiple blocks.
2517 Subsequent paragraphs are indented to show that they
2518 belong to the previous footnote.
2522 The whole paragraph can be indented, or just the first
2523 line. In this way, multi-paragraph footnotes work like
2524 multi-paragraph list items.
2526 This paragraph won't be part of the note, because it
2529The identifiers in footnote references may not contain spaces, tabs,
2530or newlines. These identifiers are used only to correlate the
2531footnote reference with the note itself; in the output, footnotes
2532will be numbered sequentially.
2534The footnotes themselves need not be placed at the end of the
2535document. They may appear anywhere except inside other block elements
2536(lists, block quotes, tables, etc.).
2538#### Extension: `inline_notes` ####
2540Inline footnotes are also allowed (though, unlike regular notes,
2541they cannot contain multiple paragraphs). The syntax is as follows:
2543 Here is an inline note.^[Inlines notes are easier to write, since
2544 you don't have to pick an identifier and move down to type the
2547Inline and regular footnotes may be mixed freely.
2553#### Extension: `citations` ####
2555Using an external filter, `pandoc-citeproc`, pandoc can automatically generate
2556citations and a bibliography in a number of styles. Basic usage is
2558 pandoc --filter pandoc-citeproc myinput.txt
2560In order to use this feature, you will need to specify a bibliography file
2561using the `bibliography` metadata field in a YAML metadata section.
2562The bibliography may have any of these formats:
2564 Format File extension
2565 ------------ --------------
2577Note that `.bib` can generally be used with both BibTeX and BibLaTeX
2578files, but you can use `.bibtex` to force BibTeX.
2580As an alternative to specifying a bibliography file, you can include
2581the citation data directly in the `references` field of the
2582document's YAML metadata. The field should contain an array of
2583YAML-encoded references, for example:
2588 title: One-click science marketing
2592 container-title: Nature Materials
2594 URL: 'http://dx.doi.org/10.1038/nmat3283'
2595 DOI: 10.1038/nmat3283
2597 publisher: Nature Publishing Group
2599 type: article-journal
2605(The program `mods2yaml`, which comes with `pandoc-citeproc`, can help produce
2606these from a MODS reference collection.)
2608By default, `pandoc-citeproc` will use a Chicago author-date format for
2609citations and references. To use another style, you will need to specify
2610a [CSL] 1.0 style file in the `csl` metadata field. A primer on creating and
2611modifying CSL styles can be found at
2612<http://citationstyles.org/downloads/primer.html>. A repository of CSL styles
2613can be found at <https://github.com/citation-style-language/styles>. See also
2614<http://zotero.org/styles> for easy browsing.
2616Citations go inside square brackets and are separated by semicolons.
2617Each citation must have a key, composed of '@' + the citation
2618identifier from the database, and may optionally have a prefix,
2619a locator, and a suffix. The citation key must begin with a letter
2620or `_`, and may contain alphanumerics, `_`, and internal punctuation
2621characters (`:.#$%&-+?<>~/`). Here are some examples:
2623 Blah blah [see @doe99, pp. 33-35; also @smith04, ch. 1].
2625 Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
2627 Blah blah [@smith04; @doe99].
2629A minus sign (`-`) before the `@` will suppress mention of
2630the author in the citation. This can be useful when the
2631author is already mentioned in the text:
2633 Smith says blah [-@smith04].
2635You can also write an in-text citation, as follows:
2639 @smith04 [p. 33] says blah.
2641If the style calls for a list of works cited, it will be placed
2642at the end of the document. Normally, you will want to end your
2643document with an appropriate header:
2649The bibliography will be inserted after this header. Note that
2650the `unnumbered` class will be added to this header, so that the
2651section will not be numbered.
2653If you want to include items in the bibliography without actually
2654citing them in the body text, you can define a dummy `nocite` metadata
2655field and put the citations there:
2664In this example, the document will contain a citation for `item3`
2665only, but the bibliography will contain entries for `item1`, `item2`, and
2668Non-pandoc extensions
2669---------------------
2671The following markdown syntax extensions are not enabled by default
2672in pandoc, but may be enabled by adding `+EXTENSION` to the format
2673name, where `EXTENSION` is the name of the extension. Thus, for
2674example, `markdown+hard_line_breaks` is markdown with hard line breaks.
2676#### Extension: `lists_without_preceding_blankline` ####
2678Allow a list to occur right after a paragraph, with no intervening
2681#### Extension: `hard_line_breaks` ####
2683Causes all newlines within a paragraph to be interpreted as hard line
2684breaks instead of spaces.
2686#### Extension: `ignore_line_breaks` ####
2688Causes newlines within a paragraph to be ignored, rather than being
2689treated as spaces or as hard line breaks. This option is intended for
2690use with East Asian languages where spaces are not used between words,
2691but text is divided into lines for readability.
2693#### Extension: `tex_math_single_backslash` ####
2695Causes anything between `\(` and `\)` to be interpreted as inline
2696TeX math, and anything between `\[` and `\]` to be interpreted
2697as display TeX math. Note: a drawback of this extension is that
2698it precludes escaping `(` and `[`.
2700#### Extension: `tex_math_double_backslash` ####
2702Causes anything between `\\(` and `\\)` to be interpreted as inline
2703TeX math, and anything between `\\[` and `\\]` to be interpreted
2706#### Extension: `markdown_attribute` ####
2708By default, pandoc interprets material inside block-level tags as markdown.
2709This extension changes the behavior so that markdown is only parsed
2710inside block-level tags if the tags have the attribute `markdown=1`.
2712#### Extension: `mmd_title_block` ####
2714Enables a [MultiMarkdown] style title block at the top of
2715the document, for example:
2719 Date: September 1, 2008
2720 Comment: This is a sample mmd title block, with
2721 a field spanning multiple lines.
2723See the MultiMarkdown documentation for details. If `pandoc_title_block` or
2724`yaml_metadata_block` is enabled, it will take precedence over
2727 [MultiMarkdown]: http://fletcherpenney.net/multimarkdown/
2729#### Extension: `abbreviations` ####
2731Parses PHP Markdown Extra abbreviation keys, like
2733 *[HTML]: Hyper Text Markup Language
2735Note that the pandoc document model does not support
2736abbreviations, so if this extension is enabled, abbreviation keys are
2737simply skipped (as opposed to being parsed as paragraphs).
2739#### Extension: `autolink_bare_uris` ####
2741Makes all absolute URIs into links, even when not surrounded by
2742pointy braces `<...>`.
2744#### Extension: `ascii_identifiers` ####
2746Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
2747Accents are stripped off of accented latin letters, and non-latin
2750#### Extension: `link_attributes` ####
2752Parses multimarkdown style key-value attributes on link and image references.
2753Note that pandoc's internal document model provides nowhere to put
2754these, so they are presently just ignored.
2756#### Extension: `mmd_header_identifiers` ####
2758Parses multimarkdown style header identifiers (in square brackets,
2759after the header but before any trailing `#`s in an ATX header).
2761#### Extension: `compact_definition_lists` ####
2763Activates the definition list syntax of pandoc 1.12.x and earlier.
2764This syntax differs from the one described [above](#definition-lists)
2767 - No blank line is required between consecutive items of the
2769 - To get a "tight" or "compact" list, omit space between consecutive
2770 items; the space between a term and its definition does not affect
2772 - Lazy wrapping of paragraphs is not allowed: the entire definition must
2773 be indented four spaces.[^6]
2775[^6]: To see why laziness is incompatible with relaxing the requirement
2776 of a blank line between items, consider the following example:
2783 Is this a single list item with two definitions of "bar," the first of
2784 which is lazily wrapped, or two list items? To remove the ambiguity
2785 we must either disallow lazy wrapping or require a blank line between
2791In addition to pandoc's extended markdown, the following markdown
2792variants are supported:
2794`markdown_phpextra` (PHP Markdown Extra)
2795: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,
2796 `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,
2797 `header_attributes`, `abbreviations`.
2799`markdown_github` (Github-flavored Markdown)
2800: `pipe_tables`, `raw_html`, `tex_math_single_backslash`,
2801 `fenced_code_blocks`, `auto_identifiers`,
2802 `ascii_identifiers`, `backtick_code_blocks`, `autolink_bare_uris`,
2803 `intraword_underscores`, `strikeout`, `hard_line_breaks`
2805`markdown_mmd` (MultiMarkdown)
2806: `pipe_tables` `raw_html`, `markdown_attribute`, `link_attributes`,
2807 `raw_tex`, `tex_math_double_backslash`, `intraword_underscores`,
2808 `mmd_title_block`, `footnotes`, `definition_lists`,
2809 `all_symbols_escapable`, `implicit_header_references`,
2810 `auto_identifiers`, `mmd_header_identifiers`
2812`markdown_strict` (Markdown.pl)
2815Extensions with formats other than markdown
2816-------------------------------------------
2818Some of the extensions discussed above can be used with formats
2821* `auto_identifiers` can be used with `latex`, `rst`, `mediawiki`,
2822 and `textile` input (and is used by default).
2824* `tex_math_dollars`, `tex_math_single_backslash`, and
2825 `tex_math_double_backslash` can be used with `html` input.
2826 (This is handy for reading web pages formatted using MathJax,
2829Producing slide shows with Pandoc
2830=================================
2832You can use Pandoc to produce an HTML + javascript slide presentation
2833that can be viewed via a web browser. There are five ways to do this,
2834using [S5], [DZSlides], [Slidy], [Slideous], or [reveal.js].
2835You can also produce a PDF slide show using LaTeX [beamer].
2837Here's the markdown source for a simple slide show, `habits.txt`:
2864 
2871To produce an HTML/javascript slide show, simply type
2873 pandoc -t FORMAT -s habits.txt -o habits.html
2875where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
2877For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
2878`-s/--standalone` option embeds a link to javascripts and CSS files, which are
2879assumed to be available at the relative path `s5/default` (for S5), `slideous`
2880(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
2881`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
2882`slideous-url`, `revealjs-url`, or `s5-url` variables; see `--variable`,
2883above.) For DZSlides, the (relatively short) javascript and css are included in
2886With all HTML slide formats, the `--self-contained` option can be used to
2887produce a single file that contains all of the data necessary to display the
2888slide show, including linked scripts, stylesheets, images, and videos.
2890To produce a PDF slide show using beamer, type
2892 pandoc -t beamer habits.txt -o habits.pdf
2894Note that a reveal.js slide show can also be converted to a PDF
2895by printing it to a file from the browser.
2897Structuring the slide show
2898--------------------------
2900By default, the *slide level* is the highest header level in
2901the hierarchy that is followed immediately by content, and not another
2902header, somewhere in the document. In the example above, level 1 headers
2903are always followed by level 2 headers, which are followed by content,
2904so 2 is the slide level. This default can be overridden using
2905the `--slide-level` option.
2907The document is carved up into slides according to the following
2910 * A horizontal rule always starts a new slide.
2912 * A header at the slide level always starts a new slide.
2914 * Headers *below* the slide level in the hierarchy create
2915 headers *within* a slide.
2917 * Headers *above* the slide level in the hierarchy create
2918 "title slides," which just contain the section title
2919 and help to break the slide show into sections.
2921 * A title page is constructed automatically from the document's title
2922 block, if present. (In the case of beamer, this can be disabled
2923 by commenting out some lines in the default template.)
2925These rules are designed to support many different styles of slide show. If
2926you don't care about structuring your slides into sections and subsections,
2927you can just use level 1 headers for all each slide. (In that case, level 1
2928will be the slide level.) But you can also structure the slide show into
2929sections, as in the example above.
2931Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
2932layout will be produced, with level 1 headers building horizontally
2933and level 2 headers building vertically. It is not recommended that
2934you use deeper nesting of section levels with reveal.js.
2939By default, these writers produces lists that display "all at once."
2940If you want your lists to display incrementally (one item at a time),
2941use the `-i` option. If you want a particular list to depart from the
2942default (that is, to display incrementally without the `-i` option and
2943all at once with the `-i` option), put it in a block quote:
2948In this way incremental and nonincremental lists can be mixed in
2954You can add "pauses" within a slide by including a paragraph containing
2955three dots, separated by spaces:
2957 # Slide with a pause
2959 content before the pause
2963 content after the pause
2968You can change the style of HTML slides by putting customized CSS files
2969in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
2970or `$DATADIR/slideous` (for Slideous),
2971where `$DATADIR` is the user data directory (see `--data-dir`, above).
2972The originals may be found in pandoc's system data directory (generally
2973`$CABALDIR/pandoc-VERSION/s5/default`). Pandoc will look there for any
2974files it does not find in the user data directory.
2976For dzslides, the CSS is included in the HTML file itself, and may
2979For reveal.js, themes can be used by setting the `theme` variable,
2984Or you can specify a custom stylesheet using the `--css` option.
2986To style beamer slides, you can specify a beamer "theme" or "colortheme"
2987using the `-V` option:
2989 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
2991Note that header attributes will turn into slide attributes
2992(on a `<div>` or `<section>`) in HTML slide formats, allowing you
2993to style individual slides. In Beamer, the only header attribute
2994that affects slides is the `allowframebreaks` class, which sets the
2995`allowframebreaks` option, causing multiple slides to be created
2996if the content overfills the frame. This is recommended especially for
2999 # References {.allowframebreaks}
3004reveal.js has good support for speaker notes. You can add notes to your
3005markdown document thus:
3010 - It can contain markdown
3015To show the notes window, press `s` while viewing the presentation.
3016Notes are not yet supported for other slide formats, but the notes
3017will not appear on the slides themselves.
3022EPUB metadata may be specified using the `--epub-metadata` option, but
3023if the source document is markdown, it is better to use a YAML metadata
3024block. Here is an example:
3031 text: An investigation of metadata
3039 text: doi:10.234234.234/33
3041 rights: © 2007 John Smith, CC BY-NC
3044The following fields are recognized:
3047 ~ Either a string value or an object with fields `text` and
3048 `scheme`. Valid values for `scheme` are `ISBN-10`,
3049 `GTIN-13`, `UPC`, `ISMN-10`, `DOI`, `LCCN`, `GTIN-14`,
3050 `ISBN-13`, `Legal deposit number`, `URN`, `OCLC`,
3051 `ISMN-13`, `ISBN-A`, `JP`, `OLCC`.
3054 ~ Either a string value, or an object with fields `file-as` and
3055 `type`, or a list of such objects. Valid values for `type` are
3056 `main`, `subtitle`, `short`, `collection`, `edition`, `extended`.
3059 ~ Either a string value, or an object with fields `role`, `file-as`,
3060 and `text`, or a list of such objects. Valid values for `role` are
3061 [marc relators](http://www.loc.gov/marc/relators/relaterm.html), but
3062 pandoc will attempt to translate the human-readable versions
3063 (like "author" and "editor") to the appropriate marc relators.
3066 ~ Same format as `creator`.
3069 ~ A string value in `YYYY-MM-DD` format. (Only the year is necessary.)
3070 Pandoc will attempt to convert other common date formats.
3073 ~ A string value in [RFC5646] format. Pandoc will default to the local
3074 language if nothing is specified.
3077 ~ A string value or a list of such values.
3098 ~ A string value (path to cover image).
3101 ~ A string value (path to CSS stylesheet).
3103`page-progression-direction`
3104 ~ Either `ltr` or `rtl`. Specifies the `page-progression-direction`
3105 spine [attribute][EPUBspine].
3107Literate Haskell support
3108========================
3110If you append `+lhs` (or `+literate_haskell`) to an appropriate input or output
3111format (`markdown`, `markdown_strict`, `rst`, or `latex` for input or output;
3112`beamer`, `html` or `html5` for output only), pandoc will treat the document as
3113literate Haskell source. This means that
3115 - In markdown input, "bird track" sections will be parsed as Haskell
3116 code rather than block quotations. Text between `\begin{code}`
3117 and `\end{code}` will also be treated as Haskell code.
3119 - In markdown output, code blocks with classes `haskell` and `literate`
3120 will be rendered using bird tracks, and block quotations will be
3121 indented one space, so they will not be treated as Haskell code.
3122 In addition, headers will be rendered setext-style (with underlines)
3123 rather than atx-style (with '#' characters). (This is because ghc
3124 treats '#' characters in column 1 as introducing line numbers.)
3126 - In restructured text input, "bird track" sections will be parsed
3129 - In restructured text output, code blocks with class `haskell` will
3130 be rendered using bird tracks.
3132 - In LaTeX input, text in `code` environments will be parsed as
3135 - In LaTeX output, code blocks with class `haskell` will be rendered
3136 inside `code` environments.
3138 - In HTML output, code blocks with class `haskell` will be rendered
3139 with class `literatehaskell` and bird tracks.
3143 pandoc -f markdown+lhs -t html
3145reads literate Haskell source formatted with markdown conventions and writes
3146ordinary HTML (without bird tracks).
3148 pandoc -f markdown+lhs -t html+lhs
3150writes HTML with the Haskell code in bird tracks, so it can be copied
3151and pasted as literate Haskell source.
3156Pandoc can be extended with custom writers written in [lua]. (Pandoc
3157includes a lua interpreter, so lua need not be installed separately.)
3159To use a custom writer, simply specify the path to the lua script
3160in place of the output format. For example:
3162 pandoc -t data/sample.lua
3164Creating a custom writer requires writing a lua function for each
3165possible element in a pandoc document. To get a documented example
3166which you can modify according to your needs, do
3168 pandoc --print-default-data-file sample.lua
3173© 2006-2013 John MacFarlane (jgm at berkeley dot edu). Released under the
3174[GPL], version 2 or greater. This software carries no warranty of
3175any kind. (See COPYRIGHT for full copyright and warranty notices.)
3176Other contributors include Recai Oktaş, Paulo Tanimoto, Peter Wang,
3177Andrea Rossato, Eric Kow, infinity0x, Luke Plant, shreevatsa.public,
3178Puneeth Chaganti, Paul Rivier, rodja.trappe, Bradley Kuhn, thsutton,
3179Nathan Gass, Jonathan Daugherty, Jérémy Bobbio, Justin Bogner, qerub,
3180Christopher Sawicki, Kelsey Hightower, Masayoshi Takahashi, Antoine
3181Latter, Ralf Stephan, Eric Seidel, B. Scott Michel, Gavin Beatty,
3182Sergey Astanin, Arlo O'Keeffe, Denis Laxalde, Brent Yorgey, David Lazar,
3183Jamie F. Olson, Matthew Pickering, Albert Krewinkel, mb21, Jesse
3186[markdown]: http://daringfireball.net/projects/markdown/
3187[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html
3188[S5]: http://meyerweb.com/eric/tools/s5/
3189[Slidy]: http://www.w3.org/Talks/Tools/Slidy/
3190[Slideous]: http://goessner.net/articles/slideous/
3191[HTML]: http://www.w3.org/TR/html40/
3192[HTML 5]: http://www.w3.org/TR/html5/
3193[XHTML]: http://www.w3.org/TR/xhtml1/
3194[LaTeX]: http://www.latex-project.org/
3195[beamer]: http://www.tex.ac.uk/CTAN/macros/latex/contrib/beamer
3196[ConTeXt]: http://www.pragma-ade.nl/
3197[RTF]: http://en.wikipedia.org/wiki/Rich_Text_Format
3198[DocBook]: http://www.docbook.org/
3199[OPML]: http://dev.opml.org/spec2.html
3200[OpenDocument]: http://opendocument.xml.org/
3201[ODT]: http://en.wikipedia.org/wiki/OpenDocument
3202[Textile]: http://redcloth.org/textile
3203[MediaWiki markup]: http://www.mediawiki.org/wiki/Help:Formatting
3204[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
3205[TWiki markup]: http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
3206[Haddock markup]: http://www.haskell.org/haddock/doc/html/ch03s08.html
3207[groff man]: http://developer.apple.com/DOCUMENTATION/Darwin/Reference/ManPages/man7/groff_man.7.html
3208[Haskell]: http://www.haskell.org/
3209[GNU Texinfo]: http://www.gnu.org/software/texinfo/
3210[Emacs Org-Mode]: http://orgmode.org
3211[AsciiDoc]: http://www.methods.co.nz/asciidoc/
3212[GPL]: http://www.gnu.org/copyleft/gpl.html "GNU General Public License"
3213[DZSlides]: http://paulrouget.com/dzslides/
3214[ISO 8601 format]: http://www.w3.org/TR/NOTE-datetime
3215[Word docx]: http://www.microsoft.com/interop/openup/openxml/default.aspx
3216[PDF]: http://www.adobe.com/pdf/
3217[reveal.js]: http://lab.hakim.se/reveal-js/
3218[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
3219[lua]: http://www.lua.org
3220[marc relators]: http://www.loc.gov/marc/relators/relaterm.html
3221[RFC5646]: http://tools.ietf.org/html/rfc5646
3222[InDesign ICML]: https://www.adobe.com/content/dam/Adobe/en/devnet/indesign/cs55-docs/IDML/idml-specification.pdf
3223[txt2tags]: http://txt2tags.org/
3224[EPUB]: http://idpf.org/epub
3225[EPUBspine]: http://www.idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
3226[KaTeX]: https://github.com/Khan/KaTeX
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