@@ -13,33 +13,19 @@ Description
1313Pandoc is a [Haskell] library for converting from one markup format to
1414another, and a command-line tool that uses this library.
1515
16−Pandoc can read [Markdown], [CommonMark], [PHP Markdown Extra],
17−[GitHub-Flavored Markdown], [MultiMarkdown], and (subsets of) [Textile],
18−[reStructuredText], [HTML], [LaTeX], [MediaWiki markup], [TWiki
19−markup], [TikiWiki markup], [Creole 1.0], [Haddock markup], [OPML],
20−[Emacs Org mode], [DocBook], [JATS], [Muse], [txt2tags], [Vimwiki],
21−[EPUB], [ODT], and [Word docx].
22−
23−Pandoc can write plain text, [Markdown],
24−[CommonMark], [PHP Markdown Extra], [GitHub-Flavored Markdown],
25−[MultiMarkdown], [reStructuredText], [XHTML], [HTML5], [LaTeX]
26−\(including [`beamer`] slide shows\), [ConTeXt], [RTF], [OPML],
27−[DocBook], [JATS], [OpenDocument], [ODT], [Word docx], [GNU Texinfo],
28−[MediaWiki markup], [DokuWiki markup], [ZimWiki markup], [Haddock
29−markup], [EPUB] \(v2 or v3\), [FictionBook2], [Textile], [groff man],
30−[groff ms], [Emacs Org mode], [AsciiDoc], [InDesign ICML], [TEI
31−Simple], [Muse], [PowerPoint] slide shows and [Slidy], [Slideous],
32−[DZSlides], [reveal.js] or [S5] HTML slide shows. It can also produce
33−[PDF] output on systems where LaTeX, ConTeXt, `pdfroff`,
34−`wkhtmltopdf`, `prince`, or `weasyprint` is installed.
16+Pandoc can convert between numerous markup and word processing formats,
17+including, but not limited to, various flavors of [Markdown], [HTML],
18+[LaTeX] and [Word docx]. For the full lists of input and output formats,
19+see the `--from` and `--to` [options below][General options].
20+
21+Pandoc can also produce [PDF] output, see [creating a PDF] below.
3522
3623Pandoc's enhanced version of Markdown includes syntax for [tables],
3724[definition lists], [metadata blocks], [`Div` blocks][Extension:
3825`fenced_divs`], [footnotes] and [citations], embedded
3926[LaTeX][Extension: `raw_tex`] (including [math]), [Markdown inside HTML
4027block elements][Extension: `markdown_in_html_blocks`], and much more.
41−These enhancements, described further under [Pandoc's Markdown],
42−can be disabled using the `markdown_strict` format.
28+See below under [Pandoc's Markdown].
4329
4430Pandoc has a modular design: it consists of a set of readers, which parse
4531text in a given format and produce a native representation of the document
@@ -58,56 +44,6 @@ model. While conversions from pandoc's Markdown to all formats aspire
5844to be perfect, conversions from formats more expressive than pandoc's
5945Markdown can be expected to be lossy.
6046
61−[Markdown]: http://daringfireball.net/projects/markdown/
62−[CommonMark]: http://commonmark.org
63−[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
64−[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
65−[MultiMarkdown]: http://fletcherpenney.net/multimarkdown/
66−[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html
67−[S5]: http://meyerweb.com/eric/tools/s5/
68−[Slidy]: http://www.w3.org/Talks/Tools/Slidy/
69−[Slideous]: http://goessner.net/articles/slideous/
70−[HTML]: http://www.w3.org/html/
71−[HTML5]: http://www.w3.org/TR/html5/
72−[polyglot markup]: https://www.w3.org/TR/html-polyglot/
73−[XHTML]: http://www.w3.org/TR/xhtml1/
74−[LaTeX]: http://latex-project.org
75−[`beamer`]: https://ctan.org/pkg/beamer
76−[Beamer User's Guide]: http://ctan.math.utah.edu/ctan/tex-archive/macros/latex/contrib/beamer/doc/beameruserguide.pdf
77−[ConTeXt]: http://www.contextgarden.net/
78−[RTF]: http://en.wikipedia.org/wiki/Rich_Text_Format
79−[DocBook]: http://docbook.org
80−[JATS]: https://jats.nlm.nih.gov
81−[txt2tags]: http://txt2tags.org
82−[EPUB]: http://idpf.org/epub
83−[OPML]: http://dev.opml.org/spec2.html
84−[OpenDocument]: http://opendocument.xml.org
85−[ODT]: http://en.wikipedia.org/wiki/OpenDocument
86−[Textile]: http://redcloth.org/textile
87−[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
88−[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
89−[ZimWiki markup]: http://zim-wiki.org/manual/Help/Wiki_Syntax.html
90−[TWiki markup]: http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
91−[TikiWiki markup]: https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax
92−[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
93−[Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0
94−[groff man]: http://man7.org/linux/man-pages/man7/groff_man.7.html
95−[groff ms]: http://man7.org/linux/man-pages/man7/groff_ms.7.html
96−[Haskell]: https://www.haskell.org
97−[GNU Texinfo]: http://www.gnu.org/software/texinfo/
98−[Emacs Org mode]: http://orgmode.org
99−[AsciiDoc]: http://www.methods.co.nz/asciidoc/
100−[DZSlides]: http://paulrouget.com/dzslides/
101−[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML
102−[PDF]: https://www.adobe.com/pdf/
103−[reveal.js]: http://lab.hakim.se/reveal-js/
104−[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
105−[InDesign ICML]: http://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf
106−[TEI Simple]: https://github.com/TEIC/TEI-Simple
107−[Muse]: https://amusewiki.org/library/manual
108−[PowerPoint]: https://en.wikipedia.org/wiki/Microsoft_PowerPoint
109−[Vimwiki]: https://vimwiki.github.io
110−
11147Using `pandoc`
11248--------------
11349
@@ -283,20 +219,39 @@ General options
283219
284220`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*
285221
286−: Specify input format. *FORMAT* can be `native` (native Haskell),
287− `json` (JSON version of native AST), `markdown` (pandoc's
288− extended Markdown), `markdown_strict` (original unextended
289− Markdown), `markdown_phpextra` (PHP Markdown Extra),
290− `markdown_mmd` (MultiMarkdown), `gfm` (GitHub-Flavored Markdown),
291− `commonmark` (CommonMark Markdown), `textile` (Textile), `rst`
292− (reStructuredText), `html` (HTML), `docbook` (DocBook), `t2t`
293− (txt2tags), `docx` (docx), `odt` (ODT), `epub` (EPUB), `opml` (OPML),
294− `org` (Emacs Org mode), `mediawiki` (MediaWiki markup), `twiki` (TWiki
295− markup), `tikiwiki` (TikiWiki markup), `creole` (Creole 1.0),
296− `haddock` (Haddock markup), or `latex` (LaTeX).
297− (`markdown_github` provides deprecated and less accurate support
298− for Github-Flavored Markdown; please use `gfm` instead, unless you
299− need to use extensions other than `smart`.)
222+: Specify input format. *FORMAT* can be:
223+
224+ - `commonmark` ([CommonMark] Markdown)
225+ - `creole` ([Creole 1.0])
226+ - `docbook` ([DocBook])
227+ - `docx` ([Word docx])
228+ - `epub` ([EPUB])
229+ - `gfm` ([GitHub-Flavored Markdown]),
230+ or `markdown_github`, which provides deprecated and less accurate
231+ support for Github-Flavored Markdown; please use `gfm` instead,
232+ unless you need to use extensions other than `smart`.
233+ - `haddock` ([Haddock markup])
234+ - `html` ([HTML])
235+ - `jats` ([JATS] XML)
236+ - `json` (JSON version of native AST)
237+ - `latex` ([LaTeX])
238+ - `markdown` ([Pandoc's Markdown])
239+ - `markdown_mmd` ([MultiMarkdown])
240+ - `markdown_phpextra` ([PHP Markdown Extra])
241+ - `markdown_strict` (original unextended [Markdown])
242+ - `mediawiki` ([MediaWiki markup])
243+ - `muse` ([Muse])
244+ - `native` (native Haskell)
245+ - `odt` ([ODT])
246+ - `opml` ([OPML])
247+ - `org` ([Emacs Org mode])
248+ - `rst` ([reStructuredText])
249+ - `t2t` ([txt2tags])
250+ - `textile` ([Textile])
251+ - `tikiwiki` ([TikiWiki markup])
252+ - `twiki` ([TWiki markup])
253+ - `vimwiki` ([Vimwiki])
254+
300255 Extensions can be individually enabled or disabled by
301256 appending `+EXTENSION` or `-EXTENSION` to the format name.
302257 See [Extensions] below, for a list of extensions and
@@ -305,34 +260,62 @@ General options
305260
306261`-t` *FORMAT*, `-w` *FORMAT*, `--to=`*FORMAT*, `--write=`*FORMAT*
307262
308−: Specify output format. *FORMAT* can be `native` (native Haskell),
309− `json` (JSON version of native AST), `plain` (plain text),
310− `markdown` (pandoc's extended Markdown), `markdown_strict`
311− (original unextended Markdown), `markdown_phpextra` (PHP Markdown
312− Extra), `markdown_mmd` (MultiMarkdown), `gfm` (GitHub-Flavored
313− Markdown), `commonmark` (CommonMark Markdown), `rst`
314− (reStructuredText), `html4` (XHTML 1.0 Transitional), `html` or
315− `html5` (HTML5/XHTML [polyglot markup]), `latex` (LaTeX), `beamer`
316− (LaTeX beamer slide show), `context` (ConTeXt), `man` (groff man),
317− `mediawiki` (MediaWiki markup), `dokuwiki` (DokuWiki markup),
318− `zimwiki` (ZimWiki markup), `textile` (Textile), `org` (Emacs Org
319− mode), `texinfo` (GNU Texinfo), `opml` (OPML), `docbook` or
320− `docbook4` (DocBook 4), `docbook5` (DocBook 5), `jats` (JATS XML),
321− `opendocument` (OpenDocument), `odt` (OpenOffice text document),
322− `docx` (Word docx), `haddock` (Haddock markup), `rtf` (rich text
323− format), `epub2` (EPUB v2 book), `epub` or `epub3` (EPUB v3),
324− `fb2` (FictionBook2 e-book), `asciidoc` (AsciiDoc), `icml`
325− (InDesign ICML), `tei` (TEI Simple), `slidy` (Slidy HTML and
326− JavaScript slide show), `slideous` (Slideous HTML and JavaScript
327− slide show), `dzslides` (DZSlides HTML5 + JavaScript slide show),
328− `revealjs` (reveal.js HTML5 + JavaScript slide show), `s5` (S5
329− HTML and JavaScript slide show), `pptx` (PowerPoint slide show) or
330− the path of a custom lua writer (see [Custom writers],
331− below). (`markdown_github` provides deprecated and less accurate
332− support for Github-Flavored Markdown; please use `gfm` instead,
333− unless you use extensions that do not work with `gfm`.) Note that
334− `odt`, `docx`, and `epub` output will not be directed to *stdout*
335− unless forced with `-o -`. Extensions can be individually enabled or
263+: Specify output format. *FORMAT* can be:
264+
265+ - `asciidoc` ([AsciiDoc])
266+ - `beamer` ([LaTeX beamer][`beamer`] slide show)
267+ - `commonmark` ([CommonMark] Markdown)
268+ - `context` ([ConTeXt])
269+ - `docbook` or `docbook4` ([DocBook] 4)
270+ - `docbook5` (DocBook 5)
271+ - `docx` ([Word docx])
272+ - `dokuwiki` ([DokuWiki markup])
273+ - `epub` or `epub3` ([EPUB] v3 book)
274+ - `epub2` (EPUB v2)
275+ - `fb2` ([FictionBook2] e-book)
276+ - `gfm` ([GitHub-Flavored Markdown]),
277+ or `markdown_github`, which provides deprecated and less accurate
278+ support for Github-Flavored Markdown; please use `gfm` instead,
279+ unless you use extensions that do not work with `gfm`.
280+ - `haddock` ([Haddock markup])
281+ - `html` or `html5` ([HTML], i.e. [HTML5]/XHTML [polyglot markup])
282+ - `html4` ([XHTML] 1.0 Transitional)
283+ - `icml` ([InDesign ICML])
284+ - `jats` ([JATS] XML)
285+ - `json` (JSON version of native AST)
286+ - `latex` ([LaTeX])
287+ - `man` ([groff man])
288+ - `markdown` ([Pandoc's Markdown])
289+ - `markdown_mmd` ([MultiMarkdown])
290+ - `markdown_phpextra` ([PHP Markdown Extra])
291+ - `markdown_strict` (original unextended [Markdown])
292+ - `mediawiki` ([MediaWiki markup])
293+ - `ms` ([groff ms])
294+ - `muse` ([Muse]),
295+ - `native` (native Haskell),
296+ - `odt` ([OpenOffice text document][ODT])
297+ - `opml` ([OPML])
298+ - `opendocument` ([OpenDocument])
299+ - `org` ([Emacs Org mode])
300+ - `plain` (plain text),
301+ - `pptx` ([PowerPoint] slide show)
302+ - `rst` ([reStructuredText])
303+ - `rtf` ([Rich Text Format])
304+ - `texinfo` ([GNU Texinfo])
305+ - `textile` ([Textile])
306+ - `slideous` ([Slideous] HTML and JavaScript slide show)
307+ - `slidy` ([Slidy] HTML and JavaScript slide show)
308+ - `dzslides` ([DZSlides] HTML5 + JavaScript slide show),
309+ - `revealjs` ([reveal.js] HTML5 + JavaScript slide show)
310+ - `s5` ([S5] HTML and JavaScript slide show)
311+ - `tei` ([TEI Simple])
312+ - `zimwiki` ([ZimWiki markup])
313+ - the path of a custom lua writer, see [Custom writers] below
314+
315+ Note that `odt`, `docx`, and `epub` output will not be directed
316+ to *stdout* unless forced with `-o -`.
317+
318+ Extensions can be individually enabled or
336319 disabled by appending `+EXTENSION` or `-EXTENSION` to the format
337320 name. See [Extensions] below, for a list of extensions and their
338321 names. See `--list-output-formats` and `--list-extensions`, below.
@@ -424,6 +407,56 @@ General options
424407
425408: Show usage message.
426409
410+[Markdown]: http://daringfireball.net/projects/markdown/
411+[CommonMark]: http://commonmark.org
412+[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
413+[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
414+[MultiMarkdown]: http://fletcherpenney.net/multimarkdown/
415+[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html
416+[S5]: http://meyerweb.com/eric/tools/s5/
417+[Slidy]: http://www.w3.org/Talks/Tools/Slidy/
418+[Slideous]: http://goessner.net/articles/slideous/
419+[HTML]: http://www.w3.org/html/
420+[HTML5]: http://www.w3.org/TR/html5/
421+[polyglot markup]: https://www.w3.org/TR/html-polyglot/
422+[XHTML]: http://www.w3.org/TR/xhtml1/
423+[LaTeX]: http://latex-project.org
424+[`beamer`]: https://ctan.org/pkg/beamer
425+[Beamer User's Guide]: http://ctan.math.utah.edu/ctan/tex-archive/macros/latex/contrib/beamer/doc/beameruserguide.pdf
426+[ConTeXt]: http://www.contextgarden.net/
427+[Rich Text Format]: http://en.wikipedia.org/wiki/Rich_Text_Format
428+[DocBook]: http://docbook.org
429+[JATS]: https://jats.nlm.nih.gov
430+[txt2tags]: http://txt2tags.org
431+[EPUB]: http://idpf.org/epub
432+[OPML]: http://dev.opml.org/spec2.html
433+[OpenDocument]: http://opendocument.xml.org
434+[ODT]: http://en.wikipedia.org/wiki/OpenDocument
435+[Textile]: http://redcloth.org/textile
436+[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
437+[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
438+[ZimWiki markup]: http://zim-wiki.org/manual/Help/Wiki_Syntax.html
439+[TWiki markup]: http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
440+[TikiWiki markup]: https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax
441+[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
442+[Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0
443+[groff man]: http://man7.org/linux/man-pages/man7/groff_man.7.html
444+[groff ms]: http://man7.org/linux/man-pages/man7/groff_ms.7.html
445+[Haskell]: https://www.haskell.org
446+[GNU Texinfo]: http://www.gnu.org/software/texinfo/
447+[Emacs Org mode]: http://orgmode.org
448+[AsciiDoc]: http://www.methods.co.nz/asciidoc/
449+[DZSlides]: http://paulrouget.com/dzslides/
450+[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML
451+[PDF]: https://www.adobe.com/pdf/
452+[reveal.js]: http://lab.hakim.se/reveal-js/
453+[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
454+[InDesign ICML]: http://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf
455+[TEI Simple]: https://github.com/TEIC/TEI-Simple
456+[Muse]: https://amusewiki.org/library/manual
457+[PowerPoint]: https://en.wikipedia.org/wiki/Microsoft_PowerPoint
458+[Vimwiki]: https://vimwiki.github.io
459+
427460Reader options
428461--------------
429462