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-8 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
227`-t`, `--to`, `-w`, or `--write` *format*
228: specifies the output format -- the format Pandoc will
229 be converting *to*. *format* can be `native`, `html`, `s5`,
230 `docbook`, `opendocument`, `latex`, `context`, `markdown`, `man`,
233`-s` or `--standalone`
234: indicates that a standalone document is to be produced (with
235 appropriate headers and footers), rather than a fragment.
237`-o` or `--output` *filename*
238: sends output to *filename*. If this option is not specified,
239 or if its argument is `-`, output will be sent to stdout.
240 (Exception: if the output format is `odt`, output to stdout
243`-p` or `--preserve-tabs`
244: causes tabs in the source text to be preserved, rather than converted
245 to spaces (the default).
247`--tab-stop` *tabstop*
248: sets the number of spaces per tab to *tabstop* (defaults to 4).
251: specifies that strict markdown syntax is to be used, without
252 pandoc's usual extensions and variants (described below). When the
253 input format is HTML, this means that constructs that have no
254 equivalents in standard markdown (e.g. definition lists or strikeout
255 text) will be parsed as raw HTML.
258: causes reference-style links to be used in markdown
259 and reStructuredText output. By default inline links are used.
262: causes the HTML and LaTeX readers to parse HTML codes and LaTeX
263 environments that it can't translate as raw HTML or LaTeX. Raw HTML can
264 be printed in markdown, reStructuredText, HTML, and S5 output; raw LaTeX
265 can be printed in markdown, reStructuredText, LaTeX, and ConTeXt output.
266 The default is for the readers to omit untranslatable HTML codes and
267 LaTeX environments. (The LaTeX reader does pass through untranslatable
268 LaTeX *commands*, even if `-R` is not specified.)
270`-C` or `--custom-header` *filename*
271: can be used to specify a custom document header. To see the headers
272 used by default, use the `-D` option: for example, `pandoc -D html`
273 prints the default HTML header.
275`--toc` or `--table-of-contents`
276: includes an automatically generated table of contents (or, in the
277 case of `latex`, `context`, and `rst`, an instruction to create
278 one) in the output document. This option has no effect with `man`,
279 `docbook`, or `s5` output formats.
281`-c` or `--css` *filename*
282: allows the user to specify a custom stylesheet that will be linked to
283 in HTML and S5 output. This option can be used repeatedly to include
284 multiple stylesheets. They will be included in the order specified.
286`-H` or `--include-in-header` *filename*
287: includes the contents of *filename* (verbatim) at the end of the
288 document header. This can be used, for example, to include special
289 CSS or javascript in HTML documents. This option can be used
290 repeatedly to include multiple files in the header. They will be
291 included in the order specified.
293`-B` or `--include-before-body` *filename*
294: includes the contents of *filename* (verbatim) at the beginning of
295 the document body (e.g. after the `<body>` tag in HTML, or the
296 `\begin{document}` command in LaTeX). This can be used to include
297 navigation bars or banners in HTML documents. This option can be
298 used repeatedly to include multiple files. They will be included in
301`-A` or `--include-after-body` *filename*
302: includes the contents of *filename* (verbatim) at the end of
303 the document body (before the `</body>` tag in HTML, or the
304 `\end{document}` command in LaTeX). This option can be be used
305 repeatedly to include multiple files. They will be included in the
308`-T` or `--title-prefix` *string*
309: includes *string* as a prefix at the beginning of the title that
310 appears in the HTML header (but not in the title as it appears at
311 the beginning of the HTML body). (See below on
312 [Title Blocks](#title-blocks).)
315: causes `pandoc` to produce typographically correct output, along the
316 lines of John Gruber's [Smartypants]. Straight quotes are converted
317 to curly quotes, `---` to dashes, and `...` to ellipses. Nonbreaking
318 spaces are inserted after certain abbreviations, such as "Mr."
319 (Note: This option is only significant when the input format is
320 `markdown`. It is selected automatically when the output format is
321 `latex` or `context`.)
323`-m`*[url]* or `--latexmathml`*[=url]*
324: causes `pandoc` to use the [LaTeXMathML] script to display
325 TeX math in HTML or S5. If a local copy of `LaTeXMathML.js` is
326 available on the webserver where the page will be viewed, provide a
327 *url* and a link will be inserted in the generated HTML or S5. If
328 no *url* is provided, the contents of the script will be inserted
329 directly; this provides portability at the price of efficiency. If
330 you plan to use math on several pages, it is much better to link to
331 a copy of `LaTeXMathML.js`, which can be cached. (See `--jsmath`,
332 `--gladtex`, and `--mimetex` for alternative ways of dealing with
336: causes `pandoc` to use the [jsMath] script to display
337 TeX math in HTML or S5. The *url* should point to the jsMath load
338 script (e.g. `jsMath/easy/load.js`). If it is provided, a link to it
339 will be included in the header of standalone HTML documents.
340 (See `--latexmathml`, `--mimetex`, and `--gladtex` for alternative
341 ways of dealing with math in HTML.)
344: causes TeX formulas to be enclosed in `<eq>` tags in HTML or S5 output.
345 This output can then be processed by [gladTeX] to produce links to
346 images with the typeset formulas. (See `--latexmathml`, `--jsmath`, and
347 `--mimetex` for alternative ways of dealing with math in HTML.)
350: causes TeX formulas to be replaced by `<img>` tags linking to the
351 [mimeTeX] CGI script, which will produce images with the typeset
352 formulas. (See `--latexmathml`, `--jsmath`, and `--gladtex` for alternative
353 ways of dealing with math in HTML.)
355`-i` or `--incremental`
356: causes all lists in S5 output to be displayed incrementally by
357 default (one item at a time). The normal default is for lists to be
358 displayed all at once.
360`-N` or `--number-sections`
361: causes sections to be numbered in LaTeX or ConTeXt output. By default,
362 sections are not numbered.
365: disables text-wrapping in output. By default, text is wrapped
366 appropriately for the output format.
369: sanitizes HTML (in markdown or HTML input) using a whitelist.
370 Unsafe tags are replaced by HTML comments; unsafe attributes
371 are omitted. URIs in links and images are also checked against a
372 whitelist of URI schemes.
375: is intended to make it easier to create wrapper scripts that use
376 Pandoc. It causes Pandoc to dump information about the arguments
377 with which it was called to stdout, then exit. The first line
378 printed is the name of the output file specified using the `-o`
379 or `--output` option, or `-` if output would go to stdout. The
380 remaining lines, if any, list command-line arguments. These will
381 include the names of input files and any special options passed
382 after ` -- ` on the command line. So, for example,
384: pandoc --dump-args -o foo.html -s foo.txt \
385 appendix.txt -- -e latin1
387: will cause the following to be printed to stdout:
389: foo.html foo.txt appendix.txt -e latin1
392: causes Pandoc to ignore all command-line arguments.
393 Regular Pandoc options are not ignored. Thus, for example,
395: pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1
399: pandoc -o foo.html -s
402: prints the version number to STDERR.
405: prints a usage message to STDERR.
407[Smartypants]: http://daringfireball.net/projects/smartypants/
408[LaTeXMathML]: http://math.etsu.edu/LaTeXMathML/
409[jsMath]: http://www.math.union.edu/~dpvc/jsmath/
410[gladTeX]: http://www.math.uio.no/~martingu/gladtex/index.html
411[mimeTeX]: http://www.forkosh.com/mimetex.html
413Pandoc's markdown vs. standard markdown
414=======================================
416In parsing markdown, Pandoc departs from and extends [standard markdown]
417in a few respects. (To run Pandoc on the official markdown test suite,
418type `make test-markdown`.) Except where noted, these differences can
419be suppressed by specifying the `--strict` command-line option or by
420using the `hsmarkdown` wrapper.
422[standard markdown]: http://daringfireball.net/projects/markdown/syntax
423 "Markdown syntax description"
428Except inside a code block or inline code, any punctuation or space
429character preceded by a backslash will be treated literally, even if it
430would normally indicate formatting. Thus, for example, if one writes
440 <strong>hello</strong>
442This rule is easier to remember than standard markdown's rule,
443which allows only the following characters to be backslash-escaped:
447A backslash-escaped space is parsed as a nonbreaking space. It will
448appear in TeX output as '~' and in HTML and XML as '\ ' or '\ '.
450Subscripts and superscripts
451---------------------------
453Superscripts may be written by surrounding the superscripted text by `^`
454characters; subscripts may be written by surrounding the subscripted
455text by `~` characters. Thus, for example,
457 H~2~O is a liquid. 2^10^ is 1024.
459If the superscripted or subscripted text contains spaces, these spaces
460must be escaped with backslashes. (This is to prevent accidental
461superscripting and subscripting through the ordinary use of `~` and `^`.)
462Thus, if you want the letter P with 'a cat' in subscripts, use
463`P~a\ cat~`, not `P~a cat~`.
468To strikeout a section of text with a horizontal line, begin and end it
469with `~~`. Thus, for example,
471 This ~~is deleted text.~~
476Pandoc behaves differently from standard markdown on some "edge
477cases" involving lists. Consider this source:
487Pandoc transforms this into a "compact list" (with no `<p>` tags around
488"First", "Second", or "Third"), while markdown puts `<p>` tags around
489"Second" and "Third" (but not "First"), because of the blank space
490around "Third". Pandoc follows a simple rule: if the text is followed by
491a blank line, it is treated as a paragraph. Since "Second" is followed
492by a list, and not a blank line, it isn't treated as a paragraph. The
493fact that the list is followed by a blank line is irrelevant. (Note:
494Pandoc works this way even when the `--strict` option is specified. This
495behavior is consistent with the official markdown syntax description,
496even though it is different from that of `Markdown.pl`.)
501Unlike standard markdown, Pandoc allows ordered list items to be marked
502with uppercase and lowercase letters and roman numerals, in addition to
503arabic numerals. (This behavior can be turned off using the `--strict`
504option.) List markers may be enclosed in parentheses or followed by a
505single right-parentheses or period. They must be separated from the
506text that follows by at least one space, and, if the list marker is a
507capital letter with a period, by at least two spaces.[^2]
509[^2]: The point of this rule is to ensure that normal paragraphs
510 starting with people's initials, like
512 B. Russell was an English philosopher.
514 do not get treated as list items.
516 This rule will not prevent
520 from being interpreted as a list item. In this case, a backslash
525Pandoc also pays attention to the type of list marker used, and to the
526starting number, and both of these are preserved where possible in the
527output format. Thus, the following yields a list with numbers followed
528by a single parenthesis, starting with 9, and a sublist with lowercase
538Note that Pandoc pays attention only to the *starting* marker in a list.
539So, the following yields a list numbered sequentially starting from 2:
546If default list markers are desired, use '`#.`':
555Pandoc supports definition lists, using a syntax inspired by
556[PHP Markdown Extra] and [reStructuredText]:
558 [PHP Markdown Extra]: http://www.michelf.com/projects/php-markdown/extra/
566 : Second paragraph of definition 2.
568Each term must fit on one line. The definition must begin on the line
569after the term. The definition consists of one or more block elements
570(paragraph, code block, list, etc.), each beginning with a colon and
571(aside from the colon) indented one tab stop.
573 Term *with inline markup*
574 : Here is the definition. It may contain multiple blocks.
579 : Here is the third paragraph of this definition.
581If you leave space after the definition (as in the first example above),
582the definitions will be considered paragraphs. In some output formats,
583this will mean greater spacing between term/definition pairs. For a
584compact definition list, do not leave space between the definition and
595Pandoc allows implicit reference links with just a single set of
596brackets. So, the following links are equivalent:
599 2. Here's my [link][]
603(Note: Pandoc works this way even if `--strict` is specified, because
604`Markdown.pl` 1.0.2b7 allows single-bracket links.)
609Pandoc's markdown allows footnotes, using the following syntax:
611 Here is a footnote reference,[^1] and another.[^longnote]
613 [^1]: Here is the footnote.
615 [^longnote]: Here's one with multiple blocks.
617 Subsequent paragraphs are indented to show that they
618 belong to the previous footnote.
622 The whole paragraph can be indented, or just the first
623 line. In this way, multi-paragraph footnotes work like
624 multi-paragraph list items.
626 This paragraph won't be part of the note, because it isn't indented.
628The identifiers in footnote references may not contain spaces, tabs,
629or newlines. These identifiers are used only to correlate the
630footnote reference with the note itself; in the output, footnotes
631will be numbered sequentially.
633The footnotes themselves need not be placed at the end of the
634document. They may appear anywhere except inside other block elements
635(lists, block quotes, tables, etc.).
637Inline footnotes are also allowed (though, unlike regular notes,
638they cannot contain multiple paragraphs). The syntax is as follows:
640 Here is an inline note.^[Inlines notes are easier to write, since
641 you don't have to pick an identifier and move down to type the
644Inline and regular footnotes may be mixed freely.
649Two kinds of tables may be used. Both kinds presuppose the use of
650a fixed-width font, such as Courier.
652Simple tables look like this:
654 Right Left Center Default
655 ------- ------ ---------- -------
660 Table: Demonstration of simple table syntax.
662The headers and table rows must each fit on one line. Column
663alignments are determined by the position of the header text relative
664to the dashed line below it:[^3]
666 - If the dashed line is flush with the header text on the right side
667 but extends beyond it on the left, the column is right-aligned.
668 - If the dashed line is flush with the header text on the left side
669 but extends beyond it on the right, the column is left-aligned.
670 - If the dashed line extends beyond the header text on both sides,
671 the column is centered.
672 - If the dashed line is flush with the header text on both sides,
673 the default alignment is used (in most cases, this will be left).
675[^3]: This scheme is due to Michel Fortin, who proposed it on the
676 [Markdown discussion list](http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html).
678The table must end with a blank line. Optionally, a caption may be
679provided (as illustrated in the example above). A caption is a paragraph
680beginning with the string `Table:`, which will be stripped off.
682The table parser pays attention to the widths of the columns, and
683the writers try to reproduce these relative widths in the output.
684So, if you find that one of the columns is too narrow in the output,
685try widening it in the markdown source.
687Multiline tables allow headers and table rows to span multiple lines
688of text. Here is an example:
690 -------------------------------------------------------------
691 Centered Default Right Left
692 Header Aligned Aligned Aligned
693 ----------- ------- --------------- -------------------------
694 First row 12.0 Example of a row that
695 spans multiple lines.
697 Second row 5.0 Here's another one. Note
698 the blank line between
700 -------------------------------------------------------------
702 Table: Here's the caption. It, too, may span
705These work like simple tables, but with the following differences:
707 - They must begin with a row of dashes, before the header text.
708 - They must end with a row of dashes, then a blank line.
709 - The rows must be separated by blank lines.
714In addition to standard indented code blocks, Pandoc supports
715*delimited* code blocks. These begin with a row of three or more
716tildes (`~`) and end with a row of tildes that must be at least
717as long as the starting row. Everything between the tilde-lines
718is treated as code. No indentation is necessary:
724If the code itself contains a row of tildes, just use a longer
725row of tildes at the start and end:
729 code including tildes
733Optionally, you may specify the language of the code block using
736 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ {.haskell .numberLines}
738 qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
739 qsort (filter (>= x) xs)
740 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
742Some output formats can use this information to do syntax highlighting.
743Currently, the only output format that uses this information is HTML.
745If pandoc has been compiled with syntax highlighting support, then the
746code block above will appear highlighted, with numbered lines. (To see
747which languages are supported, do `pandoc --version`.)
749If pandoc has not been compiled with syntax highlighting support, the
750code block above will appear as follows:
752 <pre class="haskell">
761If the file begins with a title block
764 % author(s) (separated by commas)
767it will be parsed as bibliographic information, not regular text. (It
768will be used, for example, in the title of standalone LaTeX or HTML
769output.) The block may contain just a title, a title and an author,
770or all three lines. Each must begin with a % and fit on one line.
771The title may contain standard inline formatting. If you want to
772include an author but no title, or a title and a date but no author,
773you need a blank line:
779Titles will be written only when the `--standalone` (`-s`) option is
780chosen. In HTML output, titles will appear twice: once in the
781document head -- this is the title that will appear at the top of the
782window in a browser -- and once at the beginning of the document body.
783The title in the document head can have an optional prefix attached
784(`--title-prefix` or `-T` option). The title in the body appears as
785an H1 element with class "title", so it can be suppressed or
786reformatted with CSS. If a title prefix is specified with `-T` and no
787title block appears in the document, the title prefix will be used by
788itself as the HTML title.
790The man page writer extracts a title, man page section number, and
791other header and footer information from the title line. The title
792is assumed to be the first word on the title line, which may optionally
793end with a (single-digit) section number in parentheses. (There should
794be no space between the title and the parentheses.) Anything after
795this is assumed to be additional footer and header text. A single pipe
796character (`|`) should be used to separate the footer text from the header
801will yield a man page with the title `PANDOC` and section 1.
803 % PANDOC(1) Pandoc User Manuals
805will also have "Pandoc User Manuals" in the footer.
807 % PANDOC(1) Pandoc User Manuals | Version 4.0
809will also have "Version 4.0" in the header.
811Markdown in HTML blocks
812-----------------------
814While standard markdown leaves HTML blocks exactly as they are, Pandoc
815treats text between HTML tags as markdown. Thus, for example, Pandoc
821 <td>[a link](http://google.com)</td>
829 <td><em>one</em></td>
830 <td><a href="http://google.com">a link</a></td>
834whereas `Markdown.pl` will preserve it as is.
836There is one exception to this rule: text between `<script>` and
837`</script>` tags is not interpreted as markdown.
839This departure from standard markdown should make it easier to mix
840markdown with HTML block elements. For example, one can surround
841a block of markdown text with `<div>` tags without preventing it
842from being interpreted as markdown.
844Header identifiers in HTML
845--------------------------
847Each header element in pandoc's HTML output is given a unique
848identifier. This identifier is based on the text of the header. To
849derive the identifier from the header text,
851 - Remove all formatting, links, etc.
852 - Remove all punctuation, except dashes and hyphens.
853 - Replace all spaces, dashes, newlines, and hyphens with hyphens.
854 - Convert all alphabetic characters to lowercase.
855 - Remove everything up to the first letter (identifiers may
856 not begin with a number or punctuation mark).
857 - If nothing is left after this, use the identifier `section`.
862 ------------------------------------- ---------------------------
863 Header identifiers in HTML `header-identifiers-in-html`
864 *Dogs*?--in *my* house? `dogs--in-my-house`
865 [HTML], [S5], or [RTF]? `html-s5-or-rtf`
866 3. Applications `applications`
869These rules should, in most cases, allow one to determine the identifier
870from the header text. The exception is when several headers have the
871same text; in this case, the first will get an identifier as described
872above; the second will get the same identifier with `-1` appended; the
873third with `-2`; and so on.
875These identifiers are used to provide link targets in the table of
876contents generated by the `--toc|--table-of-contents` option. They
877also make it easy to provide links from one section of a document to
878another. A link to this section, for example, might look like this:
880 See the section on [header identifiers](#header-identifiers-in-html).
882Note, however, that this method of providing links to sections works
885Blank lines before headers and blockquotes
886------------------------------------------
888Standard markdown syntax does not require a blank line before a header
889or blockquote. Pandoc does require this (except, of course, at the
890beginning of the document). The reason for the requirement is that
891it is all too easy for a `>` or `#` to end up at the beginning of a
892line by accident (perhaps through line wrapping). Consider, for
895 I like several of their flavors of ice cream: #22, for example, and
901Anything between two $ characters will be treated as TeX math. The
902opening $ must have a character immediately to its right, while the
903closing $ must have a character immediately to its left. Thus,
904`$20,000 and $30,000` won't parse as math. If for some reason
905you need to enclose text in literal $ characters, backslash-escape
906them and they won't be treated as math delimiters.
908TeX math will be printed in all output formats. In Markdown,
909reStructuredText, LaTeX, and ConTeXt output, it will appear verbatim
912In reStructuredText output, it will be rendered using an interpreted
913text role `:math:`, as described
914[here](http://www.american.edu/econ/itex2mml/mathhack.rst).
916In Texinfo output, it will be rendered inside a `@math` command.
918In groff man output, it will be rendered verbatim without $'s.
920In MediaWiki output, it will be rendered inside `<math>` tags.
922In RTF, Docbook, and OpenDocument output, it will be rendered, as far as
923possible, using unicode characters, and will otherwise appear verbatim.
924Unknown commands and symbols, and commands that cannot be dealt with
925this way (like `\frac`), will be rendered verbatim. So the results may
926be a mix of raw TeX code and properly rendered unicode math.
928In HTML and S5 output, the way math is rendered will depend on the
929command-line options selected:
9311. The default is to render TeX math as far as possible using unicode
932 characters, as with RTF, Docbook, and OpenDocument output. Formulas
933 are put inside a `span` with `class="math"`, so that they may be
934 styled differently from the surrounding text if needed.
9362. If the `--latexmathml` option is used, TeX math will be displayed
937 between $ or $$ characters and put in `<span>` tags with class `LaTeX`.
938 The [LaTeXMathML] script will be used to render it as formulas.
939 (This trick does not work in all browsers, but it works in Firefox.
940 In browsers that do not support LaTeXMathML, TeX math will appear
941 verbatim between $ characters.)
9433. If the `--jsmath` option is used, TeX math will be put inside
944 `<span>` tags (for inline math) or `<div>` tags (for display math)
945 with class `math`. The [jsMath] script will be used to render
9484. If the `--mimetex` option is used, the [mimeTeX] CGI script will
949 be called to generate images for each TeX formula. This should
950 work in all browsers. The `--mimetex` option takes an optional URL
951 as argument. If no URL is specified, it will be assumed that the
952 mimeTeX CGI script is at `/cgi-bin/mimetex.cgi`.
9545. If the `--gladtex` option is used, TeX formulas will be enclosed
955 in `<eq>` tags in the HTML output. The resulting `htex` file may then
956 be processed by [gladTeX], which will produce image files for each
957 formula and an `html` file with links to these images. So, the
960 pandoc -s --gladtex myfile.txt -o myfile.htex
961 gladtex -d myfile-images myfile.htex # produces myfile.html
962 # and images in myfile-images
967Inline TeX commands will be preserved and passed unchanged to the
968LaTeX and ConTeXt writers. Thus, for example, you can use LaTeX to
969include BibTeX citations:
971 This result was proved in \cite{jones.1967}.
973Note that in LaTeX environments, like
975 \begin{tabular}{|l|l|}\hline
976 Age & Frequency \\ \hline
979 36--45 & 22 \\ \hline
982the material between the begin and end tags will be interpreted as raw
983LaTeX, not as markdown.
985Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
991When run with the "standalone" option (`-s`), `pandoc` creates a
992standalone file, complete with an appropriate header. To see the
993default headers used for html and latex, use the following commands:
999If you want to use a different header, just create a file containing
1000it and specify it on the command line as follows:
1002 pandoc --header=MyHeaderFile
1004Producing S5 with Pandoc
1005========================
1007Producing an [S5] web-based slide show with Pandoc is easy. A title
1008page is constructed automatically from the document's title block (see
1009above). Each section (with a level-one header) produces a single slide.
1010(Note that if the section is too big, the slide will not fit on the page;
1011S5 is not smart enough to produce multiple pages.)
1013Here's the markdown source for a simple slide show, `eating.txt`:
1029To produce the slide show, simply type
1031 pandoc -w s5 -s eating.txt > eating.html
1033and open up `eating.html` in a browser.
1035Note that by default, the S5 writer produces lists that display
1036"all at once." If you want your lists to display incrementally
1037(one item at a time), use the `-i` option. If you want a
1038particular list to depart from the default (that is, to display
1039incrementally without the `-i` option and all at once with the
1040`-i` option), put it in a block quote:
1045In this way incremental and nonincremental lists can be mixed in
1048Note: the S5 file produced by pandoc with the `-s/--standalone` option
1049embeds the javascript and CSS required to show the slides. Thus it
1050does not depend on any additional files: you can send the HTML file to
1051others, and they will be able to view the slide show just by opening
1052it. However, if you intend to produce several S5 slide shows, and you
1053are displaying them on your own website, it is better to keep the S5
1054javascript and CSS files separate from the slide shows themselves, so
1055that they may be cached. The best approach in this case is to use pandoc
1056without the `-s` option to produce the body of the S5 document, which
1057can then be inserted into an HTML template that links to the javascript
1058and CSS files required by S5. (See the instructions on the S5 website.)
1059Alternatively, you may use `-s` together with the `-H/--custom-header`
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