4[](https://github.com/jgm/pandoc/releases)
5[](http://hackage.haskell.org/package/pandoc)
6[](http://brewformulas.org/Pandoc)
7[](http://stackage.org/lts/package/pandoc)
8[](https://travis-ci.org/jgm/pandoc)
9[](https://ci.appveyor.com/project/jgm/pandoc)
10[](https://www.gnu.org/licenses/gpl.html)
11[](https://groups.google.com/forum/#!forum/pandoc-discuss)
14The universal markup converter
15------------------------------
17Pandoc is a [Haskell] library for converting from one markup format to
18another, and a command-line tool that uses this library. It can read
19[Markdown], [CommonMark], [PHP Markdown Extra], [GitHub-Flavored
20Markdown], [MultiMarkdown], and (subsets of) [Textile],
21[reStructuredText], [HTML], [LaTeX], [MediaWiki markup], [TWiki markup],
22[TikiWiki markup], [Creole 1.0], [Haddock markup], [OPML], [Emacs Org mode],
23[DocBook], [JATS], [Muse], [txt2tags], [Vimwiki], [EPUB], [ODT], and
24[Word docx]; and it can write plain text, [Markdown], [CommonMark], [PHP
25Markdown Extra], [GitHub-Flavored Markdown], [MultiMarkdown],
26[reStructuredText], [XHTML], [HTML5], [LaTeX] \(including
27[`beamer`] slide shows\), [ConTeXt], [RTF], [OPML], [DocBook], [JATS],
28[OpenDocument], [ODT], [Word docx], [GNU Texinfo], [MediaWiki
29markup], [DokuWiki markup], [ZimWiki markup], [Haddock markup],
30[EPUB] \(v2 or v3\), [FictionBook2], [Textile], [groff man],
31[groff ms], [Emacs Org mode], [AsciiDoc], [InDesign ICML], [TEI
32Simple], [Muse], [PowerPoint] slide shows and [Slidy], [Slideous],
33[DZSlides], [reveal.js] or [S5] HTML slide shows. It can also produce
34[PDF] output on systems where LaTeX, ConTeXt, `pdfroff`, `wkhtmltopdf`,
35`prince`, or `weasyprint` is installed.
37Pandoc's enhanced version of Markdown includes syntax for [footnotes],
38[tables], flexible [ordered lists], [definition lists], [fenced code
39blocks], [superscripts and subscripts], [strikeout], [metadata blocks],
40automatic tables of contents, embedded LaTeX [math], [citations], and
41[Markdown inside HTML block elements](#extension-markdown_in_html_blocks).
42(These enhancements, described further under
43[Pandoc's Markdown], can be disabled using the `markdown_strict` input
46In contrast to most existing tools for converting Markdown to HTML, which
47use regex substitutions, pandoc has a modular design: it consists of a
48set of readers, which parse text in a given format and produce a native
49representation of the document, and a set of writers, which convert
50this native representation into a target format. Thus, adding an input
51or output format requires only adding a reader or writer.
53Because pandoc's intermediate representation of a document is less
54expressive than many of the formats it converts between, one should
55not expect perfect conversions between every format and every other.
56Pandoc attempts to preserve the structural elements of a document, but
57not formatting details such as margin size. And some document elements,
58such as complex tables, may not fit into pandoc's simple document
59model. While conversions from pandoc's Markdown to all formats aspire
60to be perfect, conversions from formats more expressive than pandoc's
61Markdown can be expected to be lossy.
63[Markdown]: http://daringfireball.net/projects/markdown/
64[CommonMark]: http://commonmark.org
65[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
66[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
67[MultiMarkdown]: http://fletcherpenney.net/multimarkdown/
68[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html
69[S5]: http://meyerweb.com/eric/tools/s5/
70[Slidy]: http://www.w3.org/Talks/Tools/Slidy/
71[Slideous]: http://goessner.net/articles/slideous/
72[HTML]: http://www.w3.org/html/
73[HTML5]: http://www.w3.org/TR/html5/
74[XHTML]: http://www.w3.org/TR/xhtml1/
75[LaTeX]: http://latex-project.org
76[`beamer`]: https://ctan.org/pkg/beamer
77[Beamer User's Guide]: http://ctan.math.utah.edu/ctan/tex-archive/macros/latex/contrib/beamer/doc/beameruserguide.pdf
78[ConTeXt]: http://www.contextgarden.net/
79[RTF]: http://en.wikipedia.org/wiki/Rich_Text_Format
80[Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0
81[DocBook]: http://docbook.org
82[JATS]: https://jats.nlm.nih.gov
83[txt2tags]: http://txt2tags.org
84[EPUB]: http://idpf.org/epub
85[OPML]: http://dev.opml.org/spec2.html
86[OpenDocument]: http://opendocument.xml.org
87[ODT]: http://en.wikipedia.org/wiki/OpenDocument
88[Textile]: http://redcloth.org/textile
89[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
90[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
91[ZimWiki markup]: http://zim-wiki.org/manual/Help/Wiki_Syntax.html
92[TWiki markup]: http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
93[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
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]: https://www.adobe.com/content/dam/Adobe/en/devnet/indesign/cs55-docs/IDML/idml-specification.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
113[footnotes]: http://pandoc.org/MANUAL.html#footnotes
114[tables]: http://pandoc.org/MANUAL.html#tables
115[ordered lists]: http://pandoc.org/MANUAL.html#ordered-lists
116[definition lists]: http://pandoc.org/MANUAL.html#definition-lists
117[fenced code blocks]: http://pandoc.org/MANUAL.html#fenced-code-blocks
118[superscripts and subscripts]: http://pandoc.org/MANUAL.html#superscripts-and-subscripts
119[strikeout]: http://pandoc.org/MANUAL.html#strikeout
120[metadata blocks]: http://pandoc.org/MANUAL.html#metadata-blocks
121[math]: http://pandoc.org/MANUAL.html#math
122[citations]: http://pandoc.org/MANUAL.html#citations
123[Markdown inside HTML block elements]: http://pandoc.org/MANUAL.html#extension-markdown_in_html_blocks
124[Pandoc's Markdown]: http://pandoc.org/MANUAL.html#pandocs-markdown
129Here's [how to install pandoc](INSTALL.md).
134Pandoc's website contains a full [User's Guide](https://pandoc.org/MANUAL.html).
135It is also available [here](MANUAL.txt) as pandoc-flavored Markdown.
136The website also contains some [examples of the use of
137pandoc](https://pandoc.org/demos.html) and a limited [online
138demo](https://pandoc.org/try).
143Pull requests, bug reports, and feature requests are welcome. Please make
144sure to read [the contributor guidelines](CONTRIBUTING.md) before opening a
151© 2006-2017 John MacFarlane (jgm@berkeley.edu). Released under the
152[GPL], version 2 or greater. This software carries no warranty of
153any kind. (See COPYRIGHT for full copyright and warranty notices.)
155[GPL]: http://www.gnu.org/copyleft/gpl.html "GNU General Public License"
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