5Pandoc is a [Haskell] library for converting from one markup format to
6another, and a command-line tool that uses this library. It can read
7[markdown] and (subsets of) [reStructuredText], [HTML], and [LaTeX]; and
8it can write [markdown], [reStructuredText], [HTML], [LaTeX], [ConTeXt],
9[RTF], [DocBook XML], [OpenDocument XML], [ODT], [GNU Texinfo],
10[MediaWiki markup], [groff man] pages, and [S5] HTML slide shows.
11Pandoc's enhanced version of markdown includes syntax for footnotes,
12tables, flexible ordered lists, definition lists, delimited code blocks,
13superscript, subscript, strikeout, title blocks, automatic tables of
14contents, embedded LaTeX math, and markdown inside HTML block elements.
15(These enhancements can be disabled if a drop-in replacement for
16`Markdown.pl` is desired.)
18In contrast to most existing tools for converting markdown to HTML, which
19use regex substitutions, Pandoc has a modular design: it consists of a
20set of readers, which parse text in a given format and produce a native
21representation of the document, and a set of writers, which convert
22this native representation into a target format. Thus, adding an input
23or output format requires only adding a reader or writer.
25[markdown]: http://daringfireball.net/projects/markdown/
26[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html
27[S5]: http://meyerweb.com/eric/tools/s5/
28[HTML]: http://www.w3.org/TR/html40/
29[LaTeX]: http://www.latex-project.org/
30[ConTeXt]: http://www.pragma-ade.nl/
31[RTF]: http://en.wikipedia.org/wiki/Rich_Text_Format
32[DocBook XML]: http://www.docbook.org/
33[OpenDocument XML]: http://opendocument.xml.org/
34[ODT]: http://en.wikipedia.org/wiki/OpenDocument
35[MediaWiki markup]: http://www.mediawiki.org/wiki/Help:Formatting
36[groff man]: http://developer.apple.com/DOCUMENTATION/Darwin/Reference/ManPages/man7/groff_man.7.html
37[Haskell]: http://www.haskell.org/
38[GNU Texinfo]: http://www.gnu.org/software/texinfo/
40© 2006-9 John MacFarlane (jgm at berkeley dot edu). Released under the
41[GPL], version 2 or greater. This software carries no warranty of
42any kind. (See COPYRIGHT for full copyright and warranty notices.)
43Contributors: Recai Oktaş (build system, debian package, wrapper
44scripts), Peter Wang (Texinfo writer), Andrea Rossato (OpenDocument writer).
46[GPL]: http://www.gnu.org/copyleft/gpl.html "GNU General Public License"
51If you run `pandoc` without arguments, it will accept input from
52stdin. If you run it with file names as arguments, it will take input
53from those files. By default, `pandoc` writes its output to stdout.[^1]
54If you want to write to a file, use the `-o` option:
56 pandoc -o hello.html hello.txt
58[^1]: The exception is for `odt`. Since this is a binary output format,
59 an output file must be specified explicitly.
61Note that you can specify multiple input files on the command line.
62`pandoc` will concatenate them all (with blank lines between them)
65 pandoc -s ch1.txt ch2.txt refs.txt > book.html
67(The `-s` option here tells `pandoc` to produce a standalone HTML file,
68with a proper header, rather than a fragment. For more details on this
69and many other command-line options, see below.)
71The format of the input and output can be specified explicitly using
72command-line options. The input format can be specified using the
73`-r/--read` or `-f/--from` options, the output format using the
74`-w/--write` or `-t/--to` options. Thus, to convert `hello.txt` from
75markdown to LaTeX, you could type:
77 pandoc -f markdown -t latex hello.txt
79To convert `hello.html` from html to markdown:
81 pandoc -f html -t markdown hello.html
83Supported output formats include `markdown`, `latex`, `context`
84(ConTeXt), `html`, `rtf` (rich text format), `rst`
85(reStructuredText), `docbook` (DocBook XML), `opendocument`
86(OpenDocument XML), `odt` (OpenOffice text document), `texinfo`, (GNU
87Texinfo), `mediawiki` (MediaWiki markup), `man` (groff man), and `s5`
88(which produces an HTML file that acts like powerpoint).
90Supported input formats include `markdown`, `html`, `latex`, and `rst`.
91Note that the `rst` reader only parses a subset of reStructuredText
92syntax. For example, it doesn't handle tables, option lists, or
93footnotes. But for simple documents it should be adequate. The `latex`
94and `html` readers are also limited in what they can do. Because the
95`html` reader is picky about the HTML it parses, it is recommended that
96you pipe HTML through [HTML Tidy] before sending it to `pandoc`, or use
97the `html2markdown` script described below.
99If you don't specify a reader or writer explicitly, `pandoc` will
100try to determine the input and output format from the extensions of
101the input and output filenames. Thus, for example,
103 pandoc -o hello.tex hello.txt
105will convert `hello.txt` from markdown to LaTeX. If no output file
106is specified (so that output goes to stdout), or if the output file's
107extension is unknown, the output format will default to HTML.
108If no input file is specified (so that input comes from stdin), or
109if the input files' extensions are unknown, the input format will
110be assumed to be markdown unless explicitly specified.
115All input is assumed to be in the UTF-8 encoding, and all output
116is in UTF-8. If your local character encoding is not UTF-8 and you use
117accented or foreign characters, you should pipe the input and output
118through [`iconv`]. For example,
120 iconv -t utf-8 source.txt | pandoc | iconv -f utf-8 > output.html
122will convert `source.txt` from the local encoding to UTF-8, then
123convert it to HTML, then convert back to the local encoding,
124putting the output in `output.html`.
126The shell scripts (described below) automatically convert the input
127from the local encoding to UTF-8 before running them through `pandoc`,
128then convert the output back to the local encoding.
133Three shell scripts, `markdown2pdf`, `html2markdown`, and `hsmarkdown`,
134are included in the standard Pandoc installation. (They are not included
135in the Windows binary package, as they require a POSIX shell, but they
136may be used in Windows under Cygwin.)
1381. `markdown2pdf` produces a PDF file from markdown-formatted
139 text, using `pandoc` and `pdflatex`. The default
140 behavior of `markdown2pdf` is to create a file with the same
141 base name as the first argument and the extension `pdf`; thus,
144 markdown2pdf sample.txt endnotes.txt
146 will produce `sample.pdf`. (If `sample.pdf` exists already,
147 it will be backed up before being overwritten.) An output file
148 name can be specified explicitly using the `-o` option:
150 markdown2pdf -o book.pdf chap1 chap2
152 If no input file is specified, input will be taken from stdin.
153 All of `pandoc`'s options will work with `markdown2pdf` as well.
155 `markdown2pdf` assumes that `pdflatex` is in the path. It also
156 assumes that the following LaTeX packages are available:
157 `unicode`, `fancyhdr` (if you have verbatim text in footnotes),
158 `graphicx` (if you use images), `array` (if you use tables),
159 and `ulem` (if you use strikeout text). If they are not already
160 included in your LaTeX distribution, you can get them from
161 [CTAN]. A full [TeX Live] or [MacTeX] distribution will have all of
1642. `html2markdown` grabs a web page from a file or URL and converts
165 it to markdown-formatted text, using `tidy` and `pandoc`.
167 All of `pandoc`'s options will work with `html2markdown` as well.
168 In addition, the following special options may be used.
169 The special options must be separated from the `html2markdown`
170 command and any regular Pandoc options by the delimiter `--`:
172 html2markdown -o out.txt -- -e latin1 -g curl google.com
174 The `-e` or `--encoding` option specifies the character encoding
175 of the HTML input. If this option is not specified, and input
176 is not from stdin, `html2markdown` will attempt to determine the
177 page's character encoding from the "Content-type" meta tag.
178 If this is not present, UTF-8 is assumed.
180 The `-g` or `--grabber` option specifies the command to be used to
181 fetch the contents of a URL:
183 html2markdown -g 'curl --user foo:bar' www.mysite.com
185 If this option is not specified, `html2markdown` searches for an
186 available program (`wget`, `curl`, or a text-mode browser) to fetch
187 the contents of a URL.
189 `html2markdown` requires [HTML Tidy], which must be in the path.
190 It uses [`iconv`] for character encoding conversions; if `iconv`
191 is absent, it will still work, but it will treat everything as UTF-8.
1933. `hsmarkdown` is designed to be used as a drop-in replacement for
194 `Markdown.pl`. It forces `pandoc` to convert from markdown to
195 HTML, and to use the `--strict` flag for maximal compliance with
196 official markdown syntax. (All of Pandoc's syntax extensions and
197 variants, described below, are disabled.) No other command-line
198 options are allowed. (In fact, options will be interpreted as
201 As an alternative to using the `hsmarkdown` shell script, the
202 user may create a symbolic link to `pandoc` called `hsmarkdown`.
203 When invoked under the name `hsmarkdown`, `pandoc` will behave
204 as if the `--strict` flag had been selected, and no command-line
205 options will be recognized. However, this approach does not work
206 under Cygwin, due to problems with its simulation of symbolic
209[Cygwin]: http://www.cygwin.com/
210[HTML Tidy]: http://tidy.sourceforge.net/
211[`iconv`]: http://www.gnu.org/software/libiconv/
212[CTAN]: http://www.ctan.org "Comprehensive TeX Archive Network"
213[TeX Live]: http://www.tug.org/texlive/
214[MacTeX]: http://www.tug.org/mactex/
219Various command-line options can be used to customize the output.
220For further documentation, see the `pandoc(1)` man page.
222`-f`, `--from`, `-r`, or `--read` *format*
223: specifies the input format (the format Pandoc will be converting
224 *from*). *format* can be `native`, `markdown`, `rst`, `html`, or
225 `latex`. (`+lhs` can be appended to indicate that the input should
226 be treated as literate Haskell source. See
227 [Literate Haskell support](#literate-haskell-support), below.)
229`-t`, `--to`, `-w`, or `--write` *format*
230: specifies the output format -- the format Pandoc will
231 be converting *to*. *format* can be `native`, `html`, `s5`,
232 `docbook`, `opendocument`, `latex`, `context`, `markdown`, `man`,
233 `rst`, and `rtf`. (`+lhs` can be appended to indicate that the
234 output should be treated as literate Haskell source. See
235 [Literate Haskell support](#literate-haskell-support), below.)
237`-s` or `--standalone`
238: indicates that a standalone document is to be produced (with
239 appropriate headers and footers), rather than a fragment.
241`-o` or `--output` *filename*
242: sends output to *filename*. If this option is not specified,
243 or if its argument is `-`, output will be sent to stdout.
244 (Exception: if the output format is `odt`, output to stdout
247`-p` or `--preserve-tabs`
248: causes tabs in the source text to be preserved, rather than converted
249 to spaces (the default).
251`--tab-stop` *tabstop*
252: sets the number of spaces per tab to *tabstop* (defaults to 4).
255: specifies that strict markdown syntax is to be used, without
256 pandoc's usual extensions and variants (described below). When the
257 input format is HTML, this means that constructs that have no
258 equivalents in standard markdown (e.g. definition lists or strikeout
259 text) will be parsed as raw HTML.
262: causes reference-style links to be used in markdown
263 and reStructuredText output. By default inline links are used.
266: causes the HTML and LaTeX readers to parse HTML codes and LaTeX
267 environments that it can't translate as raw HTML or LaTeX. Raw HTML can
268 be printed in markdown, reStructuredText, HTML, and S5 output; raw LaTeX
269 can be printed in markdown, reStructuredText, LaTeX, and ConTeXt output.
270 The default is for the readers to omit untranslatable HTML codes and
271 LaTeX environments. (The LaTeX reader does pass through untranslatable
272 LaTeX *commands*, even if `-R` is not specified.)
274`-C` or `--custom-header` *filename*
275: can be used to specify a custom document header. To see the headers
276 used by default, use the `-D` option: for example, `pandoc -D html`
277 prints the default HTML header. Implies `--standalone`.
279`--toc` or `--table-of-contents`
280: includes an automatically generated table of contents (or, in the
281 case of `latex`, `context`, and `rst`, an instruction to create
282 one) in the output document. This option has no effect with `man`,
283 `docbook`, or `s5` output formats.
285`-c` or `--css` *filename*
286: allows the user to specify a custom stylesheet that will be linked to
287 in HTML and S5 output. This option can be used repeatedly to include
288 multiple stylesheets. They will be included in the order specified.
289 Implies `--standalone`.
291`-H` or `--include-in-header` *filename*
292: includes the contents of *filename* (verbatim) at the end of the
293 document header. This can be used, for example, to include special
294 CSS or javascript in HTML documents. This option can be used
295 repeatedly to include multiple files in the header. They will be
296 included in the order specified. Implies `--standalone`.
298`-B` or `--include-before-body` *filename*
299: includes the contents of *filename* (verbatim) at the beginning of
300 the document body (e.g. after the `<body>` tag in HTML, or the
301 `\begin{document}` command in LaTeX). This can be used to include
302 navigation bars or banners in HTML documents. This option can be
303 used repeatedly to include multiple files. They will be included in
306`-A` or `--include-after-body` *filename*
307: includes the contents of *filename* (verbatim) at the end of
308 the document body (before the `</body>` tag in HTML, or the
309 `\end{document}` command in LaTeX). This option can be be used
310 repeatedly to include multiple files. They will be included in the
313`-T` or `--title-prefix` *string*
314: includes *string* as a prefix at the beginning of the title that
315 appears in the HTML header (but not in the title as it appears at
316 the beginning of the HTML body). (See below on
317 [Title Blocks](#title-blocks).) Implies `--standalone`.
320: causes `pandoc` to produce typographically correct output, along the
321 lines of John Gruber's [Smartypants]. Straight quotes are converted
322 to curly quotes, `---` to dashes, and `...` to ellipses. Nonbreaking
323 spaces are inserted after certain abbreviations, such as "Mr."
324 (Note: This option is only significant when the input format is
325 `markdown`. It is selected automatically when the output format is
326 `latex` or `context`.)
328`-m`*[url]* or `--latexmathml`*[=url]*
329: causes `pandoc` to use the [LaTeXMathML] script to display
330 TeX math in HTML or S5. If a local copy of `LaTeXMathML.js` is
331 available on the webserver where the page will be viewed, provide a
332 *url* and a link will be inserted in the generated HTML or S5. If
333 no *url* is provided, the contents of the script will be inserted
334 directly; this provides portability at the price of efficiency. If
335 you plan to use math on several pages, it is much better to link to
336 a copy of `LaTeXMathML.js`, which can be cached. (See `--jsmath`,
337 `--gladtex`, and `--mimetex` for alternative ways of dealing with
341: causes `pandoc` to use the [jsMath] script to display
342 TeX math in HTML or S5. The *url* should point to the jsMath load
343 script (e.g. `jsMath/easy/load.js`). If it is provided, a link to it
344 will be included in the header of standalone HTML documents.
345 (See `--latexmathml`, `--mimetex`, and `--gladtex` for alternative
346 ways of dealing with math in HTML.)
349: causes TeX formulas to be enclosed in `<eq>` tags in HTML or S5 output.
350 This output can then be processed by [gladTeX] to produce links to
351 images with the typeset formulas. (See `--latexmathml`, `--jsmath`, and
352 `--mimetex` for alternative ways of dealing with math in HTML.)
355: causes TeX formulas to be replaced by `<img>` tags linking to the
356 [mimeTeX] CGI script, which will produce images with the typeset
357 formulas. (See `--latexmathml`, `--jsmath`, and `--gladtex` for alternative
358 ways of dealing with math in HTML.)
360`-i` or `--incremental`
361: causes all lists in S5 output to be displayed incrementally by
362 default (one item at a time). The normal default is for lists to be
363 displayed all at once.
365`-N` or `--number-sections`
366: causes sections to be numbered in LaTeX, ConTeXt, or HTML output.
367 By default, sections are not numbered.
370: disables text-wrapping in output. By default, text is wrapped
371 appropriately for the output format.
374: sanitizes HTML (in markdown or HTML input) using a whitelist.
375 Unsafe tags are replaced by HTML comments; unsafe attributes
376 are omitted. URIs in links and images are also checked against a
377 whitelist of URI schemes.
379`--email-obfuscation`*=none|javascript|references*
380: specifies a method for obfuscating `mailto:` links in HTML documents.
381 *none* leaves `mailto:` links as they are. *javascript* obfuscates
382 them using javascript. *references* obfuscates them by printing their
383 letters as decimal or hexadecimal character references. If `--strict`
384 is specified, *references* is used regardless of the presence
387`--id-prefix`*=string*
388: specifies a prefix to be added to all automatically generated identifiers
389 in HTML output. This is useful for preventing duplicate identifiers
390 when generating fragments to be included in other pages.
392`--indented-code-classes`*=classes*
393: specifies classes to use for indented code blocks--for example,
394 `perl,numberLines` or `haskell`. Multiple classes may be separated
398: is intended to make it easier to create wrapper scripts that use
399 Pandoc. It causes Pandoc to dump information about the arguments
400 with which it was called to stdout, then exit. The first line
401 printed is the name of the output file specified using the `-o`
402 or `--output` option, or `-` if output would go to stdout. The
403 remaining lines, if any, list command-line arguments. These will
404 include the names of input files and any special options passed
405 after ` -- ` on the command line. So, for example,
407: pandoc --dump-args -o foo.html -s foo.txt \
408 appendix.txt -- -e latin1
410: will cause the following to be printed to stdout:
412: foo.html foo.txt appendix.txt -e latin1
415: causes Pandoc to ignore all command-line arguments.
416 Regular Pandoc options are not ignored. Thus, for example,
418: pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1
422: pandoc -o foo.html -s
425: prints the version number to STDERR.
428: prints a usage message to STDERR.
430[Smartypants]: http://daringfireball.net/projects/smartypants/
431[LaTeXMathML]: http://math.etsu.edu/LaTeXMathML/
432[jsMath]: http://www.math.union.edu/~dpvc/jsmath/
433[gladTeX]: http://www.math.uio.no/~martingu/gladtex/index.html
434[mimeTeX]: http://www.forkosh.com/mimetex.html
436Pandoc's markdown vs. standard markdown
437=======================================
439In parsing markdown, Pandoc departs from and extends [standard markdown]
440in a few respects. (To run Pandoc on the official markdown test suite,
441type `make test-markdown`.) Except where noted, these differences can
442be suppressed by specifying the `--strict` command-line option or by
443using the `hsmarkdown` wrapper.
445[standard markdown]: http://daringfireball.net/projects/markdown/syntax
446 "Markdown syntax description"
451Except inside a code block or inline code, any punctuation or space
452character preceded by a backslash will be treated literally, even if it
453would normally indicate formatting. Thus, for example, if one writes
463 <strong>hello</strong>
465This rule is easier to remember than standard markdown's rule,
466which allows only the following characters to be backslash-escaped:
470A backslash-escaped space is parsed as a nonbreaking space. It will
471appear in TeX output as '`~`' and in HTML and XML as '`\ `' or
474A backslash-escaped newline (i.e. a backslash occurring at the end of
475a line) is parsed as a hard line break. It will appear in TeX output as
476'`\\`' and in HTML as '`<br />`'. This is a nice alternative to
477markdown's "invisible" way of indicating hard line breaks using
478two trailing spaces on a line.
480Subscripts and superscripts
481---------------------------
483Superscripts may be written by surrounding the superscripted text by `^`
484characters; subscripts may be written by surrounding the subscripted
485text by `~` characters. Thus, for example,
487 H~2~O is a liquid. 2^10^ is 1024.
489If the superscripted or subscripted text contains spaces, these spaces
490must be escaped with backslashes. (This is to prevent accidental
491superscripting and subscripting through the ordinary use of `~` and `^`.)
492Thus, if you want the letter P with 'a cat' in subscripts, use
493`P~a\ cat~`, not `P~a cat~`.
498To strikeout a section of text with a horizontal line, begin and end it
499with `~~`. Thus, for example,
501 This ~~is deleted text.~~
506Pandoc behaves differently from standard markdown on some "edge
507cases" involving lists. Consider this source:
517Pandoc transforms this into a "compact list" (with no `<p>` tags around
518"First", "Second", or "Third"), while markdown puts `<p>` tags around
519"Second" and "Third" (but not "First"), because of the blank space
520around "Third". Pandoc follows a simple rule: if the text is followed by
521a blank line, it is treated as a paragraph. Since "Second" is followed
522by a list, and not a blank line, it isn't treated as a paragraph. The
523fact that the list is followed by a blank line is irrelevant. (Note:
524Pandoc works this way even when the `--strict` option is specified. This
525behavior is consistent with the official markdown syntax description,
526even though it is different from that of `Markdown.pl`.)
531Unlike standard markdown, Pandoc allows ordered list items to be marked
532with uppercase and lowercase letters and roman numerals, in addition to
533arabic numerals. (This behavior can be turned off using the `--strict`
534option.) List markers may be enclosed in parentheses or followed by a
535single right-parentheses or period. They must be separated from the
536text that follows by at least one space, and, if the list marker is a
537capital letter with a period, by at least two spaces.[^2]
539[^2]: The point of this rule is to ensure that normal paragraphs
540 starting with people's initials, like
542 B. Russell was an English philosopher.
544 do not get treated as list items.
546 This rule will not prevent
550 from being interpreted as a list item. In this case, a backslash
555Pandoc also pays attention to the type of list marker used, and to the
556starting number, and both of these are preserved where possible in the
557output format. Thus, the following yields a list with numbers followed
558by a single parenthesis, starting with 9, and a sublist with lowercase
568Note that Pandoc pays attention only to the *starting* marker in a list.
569So, the following yields a list numbered sequentially starting from 2:
576If default list markers are desired, use '`#.`':
585Pandoc supports definition lists, using a syntax inspired by
586[PHP Markdown Extra] and [reStructuredText]:
588 [PHP Markdown Extra]: http://www.michelf.com/projects/php-markdown/extra/
596 : Second paragraph of definition 2.
598Each term must fit on one line. The definition must begin on the line
599after the term. The definition consists of one or more block elements
600(paragraph, code block, list, etc.), each beginning with a colon and
601(aside from the colon) indented one tab stop.
603 Term *with inline markup*
604 : Here is the definition. It may contain multiple blocks.
609 : Here is the third paragraph of this definition.
611If you leave space after the definition (as in the first example above),
612the definitions will be considered paragraphs. In some output formats,
613this will mean greater spacing between term/definition pairs. For a
614compact definition list, do not leave space between the definition and
625Pandoc allows implicit reference links with just a single set of
626brackets. So, the following links are equivalent:
629 2. Here's my [link][]
633(Note: Pandoc works this way even if `--strict` is specified, because
634`Markdown.pl` 1.0.2b7 allows single-bracket links.)
639Pandoc's markdown allows footnotes, using the following syntax:
641 Here is a footnote reference,[^1] and another.[^longnote]
643 [^1]: Here is the footnote.
645 [^longnote]: Here's one with multiple blocks.
647 Subsequent paragraphs are indented to show that they
648 belong to the previous footnote.
652 The whole paragraph can be indented, or just the first
653 line. In this way, multi-paragraph footnotes work like
654 multi-paragraph list items.
656 This paragraph won't be part of the note, because it isn't indented.
658The identifiers in footnote references may not contain spaces, tabs,
659or newlines. These identifiers are used only to correlate the
660footnote reference with the note itself; in the output, footnotes
661will be numbered sequentially.
663The footnotes themselves need not be placed at the end of the
664document. They may appear anywhere except inside other block elements
665(lists, block quotes, tables, etc.).
667Inline footnotes are also allowed (though, unlike regular notes,
668they cannot contain multiple paragraphs). The syntax is as follows:
670 Here is an inline note.^[Inlines notes are easier to write, since
671 you don't have to pick an identifier and move down to type the
674Inline and regular footnotes may be mixed freely.
679Two kinds of tables may be used. Both kinds presuppose the use of
680a fixed-width font, such as Courier.
682Simple tables look like this:
684 Right Left Center Default
685 ------- ------ ---------- -------
690 Table: Demonstration of simple table syntax.
692The headers and table rows must each fit on one line. Column
693alignments are determined by the position of the header text relative
694to the dashed line below it:[^3]
696 - If the dashed line is flush with the header text on the right side
697 but extends beyond it on the left, the column is right-aligned.
698 - If the dashed line is flush with the header text on the left side
699 but extends beyond it on the right, the column is left-aligned.
700 - If the dashed line extends beyond the header text on both sides,
701 the column is centered.
702 - If the dashed line is flush with the header text on both sides,
703 the default alignment is used (in most cases, this will be left).
705[^3]: This scheme is due to Michel Fortin, who proposed it on the
706 [Markdown discussion list](http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html).
708The table must end with a blank line, or a line of dashes followed by
709a blank line. A caption may optionally be provided (as illustrated in
710the example above). A caption is a paragraph beginning with the string
711`Table:`, which will be stripped off.
713The column headers may be omitted, provided a dashed line is used
714to end the table. For example:
716 ------- ------ ---------- -------
720 ------- ------ ---------- -------
722When headers are omitted, column alignments are determined on the basis
723of the first line of the table body. So, in the tables above, the columns
724would be right, left, center, and right aligned, respectively.
726Multiline tables allow headers and table rows to span multiple lines
727of text. Here is an example:
729 -------------------------------------------------------------
730 Centered Default Right Left
731 Header Aligned Aligned Aligned
732 ----------- ------- --------------- -------------------------
733 First row 12.0 Example of a row that
734 spans multiple lines.
736 Second row 5.0 Here's another one. Note
737 the blank line between
739 -------------------------------------------------------------
741 Table: Here's the caption. It, too, may span
744These work like simple tables, but with the following differences:
746 - They must begin with a row of dashes, before the header text
747 (unless the headers are omitted).
748 - They must end with a row of dashes, then a blank line.
749 - The rows must be separated by blank lines.
751In multiline tables, the table parser pays attention to the widths of
752the columns, and the writers try to reproduce these relative widths in
753the output. So, if you find that one of the columns is too narrow in the
754output, try widening it in the markdown source.
756Headers may be omitted in multiline tables as well as simple tables:
758 ----------- ------- --------------- -------------------------
759 First row 12.0 Example of a row that
760 spans multiple lines.
762 Second row 5.0 Here's another one. Note
763 the blank line between
765 -------------------------------------------------------------
767 Table: Here's a multiline table without headers.
769It is possible for a multiline table to have just one row, but the row
770should be followed by a blank line (and then the row of dashes that ends
771the table), or the table may be interpreted as a simple table.
776In addition to standard indented code blocks, Pandoc supports
777*delimited* code blocks. These begin with a row of three or more
778tildes (`~`) and end with a row of tildes that must be at least
779as long as the starting row. Everything between the tilde-lines
780is treated as code. No indentation is necessary:
786Like regular code blocks, delimited code blocks must be separated
787from surrounding text by blank lines.
789If the code itself contains a row of tildes, just use a longer
790row of tildes at the start and end:
794 code including tildes
798Optionally, you may specify the language of the code block using
801 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ {.haskell .numberLines}
803 qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
804 qsort (filter (>= x) xs)
805 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
807Some output formats can use this information to do syntax highlighting.
808Currently, the only output format that uses this information is HTML.
810If pandoc has been compiled with syntax highlighting support, then the
811code block above will appear highlighted, with numbered lines. (To see
812which languages are supported, do `pandoc --version`.)
814If pandoc has not been compiled with syntax highlighting support, the
815code block above will appear as follows:
817 <pre class="haskell">
826If the file begins with a title block
829 % author(s) (separated by commas)
832it will be parsed as bibliographic information, not regular text. (It
833will be used, for example, in the title of standalone LaTeX or HTML
834output.) The block may contain just a title, a title and an author,
835or all three lines. Each must begin with a % and fit on one line.
836The title may contain standard inline formatting. If you want to
837include an author but no title, or a title and a date but no author,
838you need a blank line:
844Titles will be written only when the `--standalone` (`-s`) option is
845chosen. In HTML output, titles will appear twice: once in the
846document head -- this is the title that will appear at the top of the
847window in a browser -- and once at the beginning of the document body.
848The title in the document head can have an optional prefix attached
849(`--title-prefix` or `-T` option). The title in the body appears as
850an H1 element with class "title", so it can be suppressed or
851reformatted with CSS. If a title prefix is specified with `-T` and no
852title block appears in the document, the title prefix will be used by
853itself as the HTML title.
855The man page writer extracts a title, man page section number, and
856other header and footer information from the title line. The title
857is assumed to be the first word on the title line, which may optionally
858end with a (single-digit) section number in parentheses. (There should
859be no space between the title and the parentheses.) Anything after
860this is assumed to be additional footer and header text. A single pipe
861character (`|`) should be used to separate the footer text from the header
866will yield a man page with the title `PANDOC` and section 1.
868 % PANDOC(1) Pandoc User Manuals
870will also have "Pandoc User Manuals" in the footer.
872 % PANDOC(1) Pandoc User Manuals | Version 4.0
874will also have "Version 4.0" in the header.
876Markdown in HTML blocks
877-----------------------
879While standard markdown leaves HTML blocks exactly as they are, Pandoc
880treats text between HTML tags as markdown. Thus, for example, Pandoc
886 <td>[a link](http://google.com)</td>
894 <td><em>one</em></td>
895 <td><a href="http://google.com">a link</a></td>
899whereas `Markdown.pl` will preserve it as is.
901There is one exception to this rule: text between `<script>` and
902`</script>` tags is not interpreted as markdown.
904This departure from standard markdown should make it easier to mix
905markdown with HTML block elements. For example, one can surround
906a block of markdown text with `<div>` tags without preventing it
907from being interpreted as markdown.
909Header identifiers in HTML
910--------------------------
912Each header element in pandoc's HTML output is given a unique
913identifier. This identifier is based on the text of the header. To
914derive the identifier from the header text,
916 - Remove all formatting, links, etc.
917 - Remove all punctuation, except underscores, hyphens, periods,
919 - Replace all spaces and newlines with hyphens.
920 - Convert all alphabetic characters to lowercase.
921 - Remove everything up to the first letter (identifiers may
922 not begin with a number or punctuation mark).
923 - If nothing is left after this, use the identifier `section`.
928 ------------------------------------- ---------------------------
929 Header identifiers in HTML `header-identifiers-in-html`
930 *Dogs*?--in *my* house? `dogs--in-my-house`
931 [HTML], [S5], or [RTF]? `html-s5-or-rtf`
932 3. Applications `applications`
935These rules should, in most cases, allow one to determine the identifier
936from the header text. The exception is when several headers have the
937same text; in this case, the first will get an identifier as described
938above; the second will get the same identifier with `-1` appended; the
939third with `-2`; and so on.
941These identifiers are used to provide link targets in the table of
942contents generated by the `--toc|--table-of-contents` option. They
943also make it easy to provide links from one section of a document to
944another. A link to this section, for example, might look like this:
946 See the section on [header identifiers](#header-identifiers-in-html).
948Note, however, that this method of providing links to sections works
951Blank lines before headers and blockquotes
952------------------------------------------
954Standard markdown syntax does not require a blank line before a header
955or blockquote. Pandoc does require this (except, of course, at the
956beginning of the document). The reason for the requirement is that
957it is all too easy for a `>` or `#` to end up at the beginning of a
958line by accident (perhaps through line wrapping). Consider, for
961 I like several of their flavors of ice cream: #22, for example, and
967Anything between two $ characters will be treated as TeX math. The
968opening $ must have a character immediately to its right, while the
969closing $ must have a character immediately to its left. Thus,
970`$20,000 and $30,000` won't parse as math. If for some reason
971you need to enclose text in literal $ characters, backslash-escape
972them and they won't be treated as math delimiters.
974TeX math will be printed in all output formats. In Markdown,
975reStructuredText, LaTeX, and ConTeXt output, it will appear verbatim
978In reStructuredText output, it will be rendered using an interpreted
979text role `:math:`, as described
980[here](http://www.american.edu/econ/itex2mml/mathhack.rst).
982In Texinfo output, it will be rendered inside a `@math` command.
984In groff man output, it will be rendered verbatim without $'s.
986In MediaWiki output, it will be rendered inside `<math>` tags.
988In RTF, Docbook, and OpenDocument output, it will be rendered, as far as
989possible, using unicode characters, and will otherwise appear verbatim.
990Unknown commands and symbols, and commands that cannot be dealt with
991this way (like `\frac`), will be rendered verbatim. So the results may
992be a mix of raw TeX code and properly rendered unicode math.
994In HTML and S5 output, the way math is rendered will depend on the
995command-line options selected:
9971. The default is to render TeX math as far as possible using unicode
998 characters, as with RTF, Docbook, and OpenDocument output. Formulas
999 are put inside a `span` with `class="math"`, so that they may be
1000 styled differently from the surrounding text if needed.
10022. If the `--latexmathml` option is used, TeX math will be displayed
1003 between $ or $$ characters and put in `<span>` tags with class `LaTeX`.
1004 The [LaTeXMathML] script will be used to render it as formulas.
1005 (This trick does not work in all browsers, but it works in Firefox.
1006 In browsers that do not support LaTeXMathML, TeX math will appear
1007 verbatim between $ characters.)
10093. If the `--jsmath` option is used, TeX math will be put inside
1010 `<span>` tags (for inline math) or `<div>` tags (for display math)
1011 with class `math`. The [jsMath] script will be used to render
10144. If the `--mimetex` option is used, the [mimeTeX] CGI script will
1015 be called to generate images for each TeX formula. This should
1016 work in all browsers. The `--mimetex` option takes an optional URL
1017 as argument. If no URL is specified, it will be assumed that the
1018 mimeTeX CGI script is at `/cgi-bin/mimetex.cgi`.
10205. If the `--gladtex` option is used, TeX formulas will be enclosed
1021 in `<eq>` tags in the HTML output. The resulting `htex` file may then
1022 be processed by [gladTeX], which will produce image files for each
1023 formula and an `html` file with links to these images. So, the
1026 pandoc -s --gladtex myfile.txt -o myfile.htex
1027 gladtex -d myfile-images myfile.htex # produces myfile.html
1028 # and images in myfile-images
1033Inline TeX commands will be preserved and passed unchanged to the
1034LaTeX and ConTeXt writers. Thus, for example, you can use LaTeX to
1035include BibTeX citations:
1037 This result was proved in \cite{jones.1967}.
1039Note that in LaTeX environments, like
1041 \begin{tabular}{|l|l|}\hline
1042 Age & Frequency \\ \hline
1045 36--45 & 22 \\ \hline
1048the material between the begin and end tags will be interpreted as raw
1049LaTeX, not as markdown.
1051Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
1057When run with the "standalone" option (`-s`), `pandoc` creates a
1058standalone file, complete with an appropriate header. To see the
1059default headers used for html and latex, use the following commands:
1065If you want to use a different header, just create a file containing
1066it and specify it on the command line as follows:
1068 pandoc --custom-header=MyHeaderFile
1070Producing S5 with Pandoc
1071========================
1073Producing an [S5] web-based slide show with Pandoc is easy. A title
1074page is constructed automatically from the document's title block (see
1075above). Each section (with a level-one header) produces a single slide.
1076(Note that if the section is too big, the slide will not fit on the page;
1077S5 is not smart enough to produce multiple pages.)
1079Here's the markdown source for a simple slide show, `eating.txt`:
1095To produce the slide show, simply type
1097 pandoc -w s5 -s eating.txt > eating.html
1099and open up `eating.html` in a browser.
1101Note that by default, the S5 writer produces lists that display
1102"all at once." If you want your lists to display incrementally
1103(one item at a time), use the `-i` option. If you want a
1104particular list to depart from the default (that is, to display
1105incrementally without the `-i` option and all at once with the
1106`-i` option), put it in a block quote:
1111In this way incremental and nonincremental lists can be mixed in
1114Note: the S5 file produced by pandoc with the `-s/--standalone` option
1115embeds the javascript and CSS required to show the slides. Thus it
1116does not depend on any additional files: you can send the HTML file to
1117others, and they will be able to view the slide show just by opening
1118it. However, if you intend to produce several S5 slide shows, and you
1119are displaying them on your own website, it is better to keep the S5
1120javascript and CSS files separate from the slide shows themselves, so
1121that they may be cached. The best approach in this case is to use pandoc
1122without the `-s` option to produce the body of the S5 document, which
1123can then be inserted into an HTML template that links to the javascript
1124and CSS files required by S5. (See the instructions on the S5 website.)
1125Alternatively, you may use `-s` together with the `-C/--custom-header`
1128Literate Haskell support
1129========================
1131If you append `+lhs` to an appropriate input or output format (`markdown`,
1132`rst`, or `latex` for input or output; `html` for output only), pandoc
1133will treat the document as literate Haskell source. This means that
1135 - In markdown input, "bird track" sections will be parsed as Haskell
1136 code rather than block quotations. Text between `\begin{code}`
1137 and `\end{code}` will also be treated as Haskell code.
1139 - In markdown output, code blocks with class `haskell` will be
1140 rendered using bird tracks, and block quotations will be
1141 indented one space, so they will not be treated as Haskell code.
1142 In addition, headers will be rendered setext-style (with underlines)
1143 rather than atx-style (with '#' characters). (This is because ghc
1144 treats '#' characters in column 1 as introducing line numbers.)
1146 - In restructured text input, "bird track" sections will be parsed
1149 - In restructured text output, code blocks with class `haskell` will
1150 be rendered using bird tracks.
1152 - In LaTeX input, text in `code` environments will be parsed as
1155 - In LaTeX output, code blocks with class `haskell` will be rendered
1156 inside `code` environments.
1158 - In HTML output, code blocks with class `haskell` will be rendered
1159 with class `literatehaskell` and bird tracks.
1163 pandoc -f markdown+lhs -t html
1165reads literate Haskell source formatted with markdown conventions and writes
1166ordinary HTML (without bird tracks).
1168 pandoc -f markdown+lhs -t html+lhs
1170writes HTML with the Haskell code in bird tracks, so it can be copied
1171and pasted as literate Haskell source.
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