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 `--gladtex`
332 and `--mimetex` for alternative ways of dealing with math in HTML.)
335: causes TeX formulas to be enclosed in `<eq>` tags in HTML or S5 output.
336 This output can then be processed by [gladTeX] to produce links to
337 images with the typeset formulas. (See `--latexmathml` and
338 `--mimetex` for alternative ways of dealing with math in HTML.)
341: causes TeX formulas to be replaced by `<img>` tags linking to the
342 [mimeTeX] CGI script, which will produce images with the typeset
343 formulas. (See `--latexmathml` and `--mimetex` for alternative
344 ways of dealing with math in HTML.)
346`-i` or `--incremental`
347: causes all lists in S5 output to be displayed incrementally by
348 default (one item at a time). The normal default is for lists to be
349 displayed all at once.
351`-N` or `--number-sections`
352: causes sections to be numbered in LaTeX or ConTeXt output. By default,
353 sections are not numbered.
356: disables text-wrapping in output. By default, text is wrapped
357 appropriately for the output format.
360: sanitizes HTML (in markdown or HTML input) using a whitelist.
361 Unsafe tags are replaced by HTML comments; unsafe attributes
362 are omitted. URIs in links and images are also checked against a
363 whitelist of URI schemes.
366: is intended to make it easier to create wrapper scripts that use
367 Pandoc. It causes Pandoc to dump information about the arguments
368 with which it was called to stdout, then exit. The first line
369 printed is the name of the output file specified using the `-o`
370 or `--output` option, or `-` if output would go to stdout. The
371 remaining lines, if any, list command-line arguments. These will
372 include the names of input files and any special options passed
373 after ` -- ` on the command line. So, for example,
375: pandoc --dump-args -o foo.html -s foo.txt \
376 appendix.txt -- -e latin1
378: will cause the following to be printed to stdout:
380: foo.html foo.txt appendix.txt -e latin1
383: causes Pandoc to ignore all command-line arguments.
384 Regular Pandoc options are not ignored. Thus, for example,
386: pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1
390: pandoc -o foo.html -s
393: prints the version number to STDERR.
396: prints a usage message to STDERR.
398[Smartypants]: http://daringfireball.net/projects/smartypants/
399[LaTeXMathML]: http://math.etsu.edu/LaTeXMathML/
400[gladTeX]: http://www.math.uio.no/~martingu/gladtex/index.html
401[mimeTeX]: http://www.forkosh.com/mimetex.html
403Pandoc's markdown vs. standard markdown
404=======================================
406In parsing markdown, Pandoc departs from and extends [standard markdown]
407in a few respects. (To run Pandoc on the official markdown test suite,
408type `make test-markdown`.) Except where noted, these differences can
409be suppressed by specifying the `--strict` command-line option or by
410using the `hsmarkdown` wrapper.
412[standard markdown]: http://daringfireball.net/projects/markdown/syntax
413 "Markdown syntax description"
418Except inside a code block or inline code, any punctuation or space
419character preceded by a backslash will be treated literally, even if it
420would normally indicate formatting. Thus, for example, if one writes
430 <strong>hello</strong>
432This rule is easier to remember than standard markdown's rule,
433which allows only the following characters to be backslash-escaped:
437A backslash-escaped space is parsed as a nonbreaking space. It will
438appear in TeX output as '~' and in HTML and XML as '\ ' or '\ '.
440Subscripts and superscripts
441---------------------------
443Superscripts may be written by surrounding the superscripted text by `^`
444characters; subscripts may be written by surrounding the subscripted
445text by `~` characters. Thus, for example,
447 H~2~O is a liquid. 2^10^ is 1024.
449If the superscripted or subscripted text contains spaces, these spaces
450must be escaped with backslashes. (This is to prevent accidental
451superscripting and subscripting through the ordinary use of `~` and `^`.)
452Thus, if you want the letter P with 'a cat' in subscripts, use
453`P~a\ cat~`, not `P~a cat~`.
458To strikeout a section of text with a horizontal line, begin and end it
459with `~~`. Thus, for example,
461 This ~~is deleted text.~~
466Pandoc behaves differently from standard markdown on some "edge
467cases" involving lists. Consider this source:
477Pandoc transforms this into a "compact list" (with no `<p>` tags around
478"First", "Second", or "Third"), while markdown puts `<p>` tags around
479"Second" and "Third" (but not "First"), because of the blank space
480around "Third". Pandoc follows a simple rule: if the text is followed by
481a blank line, it is treated as a paragraph. Since "Second" is followed
482by a list, and not a blank line, it isn't treated as a paragraph. The
483fact that the list is followed by a blank line is irrelevant. (Note:
484Pandoc works this way even when the `--strict` option is specified. This
485behavior is consistent with the official markdown syntax description,
486even though it is different from that of `Markdown.pl`.)
491Unlike standard markdown, Pandoc allows ordered list items to be marked
492with uppercase and lowercase letters and roman numerals, in addition to
493arabic numerals. (This behavior can be turned off using the `--strict`
494option.) List markers may be enclosed in parentheses or followed by a
495single right-parentheses or period. They must be separated from the
496text that follows by at least one space, and, if the list marker is a
497capital letter with a period, by at least two spaces.[^2]
499[^2]: The point of this rule is to ensure that normal paragraphs
500 starting with people's initials, like
502 B. Russell was an English philosopher.
504 do not get treated as list items.
506 This rule will not prevent
510 from being interpreted as a list item. In this case, a backslash
515Pandoc also pays attention to the type of list marker used, and to the
516starting number, and both of these are preserved where possible in the
517output format. Thus, the following yields a list with numbers followed
518by a single parenthesis, starting with 9, and a sublist with lowercase
528Note that Pandoc pays attention only to the *starting* marker in a list.
529So, the following yields a list numbered sequentially starting from 2:
536If default list markers are desired, use '`#.`':
545Pandoc supports definition lists, using a syntax inspired by
546[PHP Markdown Extra] and [reStructuredText]:
548 [PHP Markdown Extra]: http://www.michelf.com/projects/php-markdown/extra/
556 : Second paragraph of definition 2.
558Each term must fit on one line. The definition must begin on the line
559after the term. The definition consists of one or more block elements
560(paragraph, code block, list, etc.), each beginning with a colon and
561(aside from the colon) indented one tab stop.
563 Term *with inline markup*
564 : Here is the definition. It may contain multiple blocks.
569 : Here is the third paragraph of this definition.
571If you leave space after the definition (as in the first example above),
572the definitions will be considered paragraphs. In some output formats,
573this will mean greater spacing between term/definition pairs. For a
574compact definition list, do not leave space between the definition and
585Pandoc allows implicit reference links with just a single set of
586brackets. So, the following links are equivalent:
589 2. Here's my [link][]
593(Note: Pandoc works this way even if `--strict` is specified, because
594`Markdown.pl` 1.0.2b7 allows single-bracket links.)
599Pandoc's markdown allows footnotes, using the following syntax:
601 Here is a footnote reference,[^1] and another.[^longnote]
603 [^1]: Here is the footnote.
605 [^longnote]: Here's one with multiple blocks.
607 Subsequent paragraphs are indented to show that they
608 belong to the previous footnote.
612 The whole paragraph can be indented, or just the first
613 line. In this way, multi-paragraph footnotes work like
614 multi-paragraph list items.
616 This paragraph won't be part of the note, because it isn't indented.
618The identifiers in footnote references may not contain spaces, tabs,
619or newlines. These identifiers are used only to correlate the
620footnote reference with the note itself; in the output, footnotes
621will be numbered sequentially.
623The footnotes themselves need not be placed at the end of the
624document. They may appear anywhere except inside other block elements
625(lists, block quotes, tables, etc.).
627Inline footnotes are also allowed (though, unlike regular notes,
628they cannot contain multiple paragraphs). The syntax is as follows:
630 Here is an inline note.^[Inlines notes are easier to write, since
631 you don't have to pick an identifier and move down to type the
634Inline and regular footnotes may be mixed freely.
639Two kinds of tables may be used. Both kinds presuppose the use of
640a fixed-width font, such as Courier.
642Simple tables look like this:
644 Right Left Center Default
645 ------- ------ ---------- -------
650 Table: Demonstration of simple table syntax.
652The headers and table rows must each fit on one line. Column
653alignments are determined by the position of the header text relative
654to the dashed line below it:[^3]
656 - If the dashed line is flush with the header text on the right side
657 but extends beyond it on the left, the column is right-aligned.
658 - If the dashed line is flush with the header text on the left side
659 but extends beyond it on the right, the column is left-aligned.
660 - If the dashed line extends beyond the header text on both sides,
661 the column is centered.
662 - If the dashed line is flush with the header text on both sides,
663 the default alignment is used (in most cases, this will be left).
665[^3]: This scheme is due to Michel Fortin, who proposed it on the
666 [Markdown discussion list](http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html).
668The table must end with a blank line. Optionally, a caption may be
669provided (as illustrated in the example above). A caption is a paragraph
670beginning with the string `Table:`, which will be stripped off.
672The table parser pays attention to the widths of the columns, and
673the writers try to reproduce these relative widths in the output.
674So, if you find that one of the columns is too narrow in the output,
675try widening it in the markdown source.
677Multiline tables allow headers and table rows to span multiple lines
678of text. Here is an example:
680 -------------------------------------------------------------
681 Centered Default Right Left
682 Header Aligned Aligned Aligned
683 ----------- ------- --------------- -------------------------
684 First row 12.0 Example of a row that
685 spans multiple lines.
687 Second row 5.0 Here's another one. Note
688 the blank line between
690 -------------------------------------------------------------
692 Table: Here's the caption. It, too, may span
695These work like simple tables, but with the following differences:
697 - They must begin with a row of dashes, before the header text.
698 - They must end with a row of dashes, then a blank line.
699 - The rows must be separated by blank lines.
704In addition to standard indented code blocks, Pandoc supports
705*delimited* code blocks. These begin with a row of three or more
706tildes (`~`) and end with a row of tildes that must be at least
707as long as the starting row. Everything between the tilde-lines
708is treated as code. No indentation is necessary:
714If the code itself contains a row of tildes, just use a longer
715row of tildes at the start and end:
719 code including tildes
723Optionally, you may specify the language of the code block using
726 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ {.haskell .numberLines}
728 qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
729 qsort (filter (>= x) xs)
730 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
732Some output formats can use this information to do syntax highlighting.
733Currently, the only output format that uses this information is HTML.
735If pandoc has been compiled with syntax highlighting support, then the
736code block above will appear highlighted, with numbered lines. (To see
737which languages are supported, do `pandoc --version`.)
739If pandoc has not been compiled with syntax highlighting support, the
740code block above will appear as follows:
742 <pre class="haskell">
751If the file begins with a title block
754 % author(s) (separated by commas)
757it will be parsed as bibliographic information, not regular text. (It
758will be used, for example, in the title of standalone LaTeX or HTML
759output.) The block may contain just a title, a title and an author,
760or all three lines. Each must begin with a % and fit on one line.
761The title may contain standard inline formatting. If you want to
762include an author but no title, or a title and a date but no author,
763you need a blank line:
769Titles will be written only when the `--standalone` (`-s`) option is
770chosen. In HTML output, titles will appear twice: once in the
771document head -- this is the title that will appear at the top of the
772window in a browser -- and once at the beginning of the document body.
773The title in the document head can have an optional prefix attached
774(`--title-prefix` or `-T` option). The title in the body appears as
775an H1 element with class "title", so it can be suppressed or
776reformatted with CSS. If a title prefix is specified with `-T` and no
777title block appears in the document, the title prefix will be used by
778itself as the HTML title.
780The man page writer extracts a title, man page section number, and
781other header and footer information from the title line. The title
782is assumed to be the first word on the title line, which may optionally
783end with a (single-digit) section number in parentheses. (There should
784be no space between the title and the parentheses.) Anything after
785this is assumed to be additional footer and header text. A single pipe
786character (`|`) should be used to separate the footer text from the header
791will yield a man page with the title `PANDOC` and section 1.
793 % PANDOC(1) Pandoc User Manuals
795will also have "Pandoc User Manuals" in the footer.
797 % PANDOC(1) Pandoc User Manuals | Version 4.0
799will also have "Version 4.0" in the header.
801Markdown in HTML blocks
802-----------------------
804While standard markdown leaves HTML blocks exactly as they are, Pandoc
805treats text between HTML tags as markdown. Thus, for example, Pandoc
811 <td>[a link](http://google.com)</td>
819 <td><em>one</em></td>
820 <td><a href="http://google.com">a link</a></td>
824whereas `Markdown.pl` will preserve it as is.
826There is one exception to this rule: text between `<script>` and
827`</script>` tags is not interpreted as markdown.
829This departure from standard markdown should make it easier to mix
830markdown with HTML block elements. For example, one can surround
831a block of markdown text with `<div>` tags without preventing it
832from being interpreted as markdown.
834Header identifiers in HTML
835--------------------------
837Each header element in pandoc's HTML output is given a unique
838identifier. This identifier is based on the text of the header. To
839derive the identifier from the header text,
841 - Remove all formatting, links, etc.
842 - Remove all punctuation, except dashes and hyphens.
843 - Replace all spaces, dashes, newlines, and hyphens with hyphens.
844 - Convert all alphabetic characters to lowercase.
845 - Remove everything up to the first letter (identifiers may
846 not begin with a number or punctuation mark).
847 - If nothing is left after this, use the identifier `section`.
852 ------------------------------------- ---------------------------
853 Header identifiers in HTML `header-identifiers-in-html`
854 *Dogs*?--in *my* house? `dogs--in-my-house`
855 [HTML], [S5], or [RTF]? `html-s5-or-rtf`
856 3. Applications `applications`
859These rules should, in most cases, allow one to determine the identifier
860from the header text. The exception is when several headers have the
861same text; in this case, the first will get an identifier as described
862above; the second will get the same identifier with `-1` appended; the
863third with `-2`; and so on.
865These identifiers are used to provide link targets in the table of
866contents generated by the `--toc|--table-of-contents` option. They
867also make it easy to provide links from one section of a document to
868another. A link to this section, for example, might look like this:
870 See the section on [header identifiers](#header-identifiers-in-html).
872Note, however, that this method of providing links to sections works
875Blank lines before headers and blockquotes
876------------------------------------------
878Standard markdown syntax does not require a blank line before a header
879or blockquote. Pandoc does require this (except, of course, at the
880beginning of the document). The reason for the requirement is that
881it is all too easy for a `>` or `#` to end up at the beginning of a
882line by accident (perhaps through line wrapping). Consider, for
885 I like several of their flavors of ice cream: #22, for example, and
891Anything between two $ characters will be treated as TeX math. The
892opening $ must have a character immediately to its right, while the
893closing $ must have a character immediately to its left. Thus,
894`$20,000 and $30,000` won't parse as math. If for some reason
895you need to enclose text in literal $ characters, backslash-escape
896them and they won't be treated as math delimiters.
898TeX math will be printed in all output formats. In Markdown,
899reStructuredText, LaTeX, and ConTeXt output, it will appear verbatim
902In reStructuredText output, it will be rendered using an interpreted
903text role `:math:`, as described
904[here](http://www.american.edu/econ/itex2mml/mathhack.rst).
906In Texinfo output, it will be rendered inside a `@math` command.
908In groff man output, it will be rendered verbatim without $'s.
910In MediaWiki output, it will be rendered inside `<math>` tags.
912In RTF, Docbook, and OpenDocument output, it will be rendered, as far as
913possible, using unicode characters, and will otherwise appear verbatim.
914Unknown commands and symbols, and commands that cannot be dealt with
915this way (like `\frac`), will be rendered verbatim. So the results may
916be a mix of raw TeX code and properly rendered unicode math.
918In HTML and S5 output, the way math is rendered will depend on the
919command-line options selected:
9211. The default is to render TeX math as far as possible using unicode
922 characters, as with RTF, Docbook, and OpenDocument output. Formulas
923 are put inside a `span` with `class="math"`, so that they may be
924 styled differently from the surrounding text if needed.
9262. If the `--latexmathml` option is used, TeX math will be displayed
927 between $ characters, as in LaTeX, and the [LaTeXMathML] script will
928 be used to render it as formulas. (This trick does not work in all
929 browsers, but it works in Firefox. In browsers that do not support
930 LaTeXMathML, TeX math will appear verbatim between $ characters.)
9323. If the `--mimetex` option is used, the [mimeTeX] CGI script will
933 be called to generate images for each TeX formula. This should
934 work in all browsers. The `--mimetex` option takes an optional URL
935 as argument. If no URL is specified, it will be assumed that the
936 mimeTeX CGI script is at `/cgi-bin/mimetex.cgi`.
9384. If the `--gladtex` option is used, TeX formulas will be enclosed
939 in `<eq>` tags in the HTML output. The resulting `htex` file may then
940 be processed by [gladTeX], which will produce image files for each
941 formula and an `html` file with links to these images. So, the
944 pandoc -s --gladtex myfile.txt -o myfile.htex
945 gladtex -d myfile-images myfile.htex # produces myfile.html
946 # and images in myfile-images
951Inline TeX commands will be preserved and passed unchanged to the
952LaTeX and ConTeXt writers. Thus, for example, you can use LaTeX to
953include BibTeX citations:
955 This result was proved in \cite{jones.1967}.
957Note that in LaTeX environments, like
959 \begin{tabular}{|l|l|}\hline
960 Age & Frequency \\ \hline
963 36--45 & 22 \\ \hline
966the material between the begin and end tags will be interpreted as raw
967LaTeX, not as markdown.
969Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
975When run with the "standalone" option (`-s`), `pandoc` creates a
976standalone file, complete with an appropriate header. To see the
977default headers used for html and latex, use the following commands:
983If you want to use a different header, just create a file containing
984it and specify it on the command line as follows:
986 pandoc --header=MyHeaderFile
988Producing S5 with Pandoc
989========================
991Producing an [S5] web-based slide show with Pandoc is easy. A title
992page is constructed automatically from the document's title block (see
993above). Each section (with a level-one header) produces a single slide.
994(Note that if the section is too big, the slide will not fit on the page;
995S5 is not smart enough to produce multiple pages.)
997Here's the markdown source for a simple slide show, `eating.txt`:
1013To produce the slide show, simply type
1015 pandoc -w s5 -s eating.txt > eating.html
1017and open up `eating.html` in a browser.
1019Note that by default, the S5 writer produces lists that display
1020"all at once." If you want your lists to display incrementally
1021(one item at a time), use the `-i` option. If you want a
1022particular list to depart from the default (that is, to display
1023incrementally without the `-i` option and all at once with the
1024`-i` option), put it in a block quote:
1029In this way incremental and nonincremental lists can be mixed in
1032Note: the S5 file produced by pandoc with the `-s/--standalone` option
1033embeds the javascript and CSS required to show the slides. Thus it
1034does not depend on any additional files: you can send the HTML file to
1035others, and they will be able to view the slide show just by opening
1036it. However, if you intend to produce several S5 slide shows, and you
1037are displaying them on your own website, it is better to keep the S5
1038javascript and CSS files separate from the slide shows themselves, so
1039that they may be cached. The best approach in this case is to use pandoc
1040without the `-s` option to produce the body of the S5 document, which
1041can then be inserted into an HTML template that links to the javascript
1042and CSS files required by S5. (See the instructions on the S5 website.)
1043Alternatively, 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