4The universal markup converter
5------------------------------
7Pandoc is a [Haskell] library for converting from one markup format to
8another, and a command-line tool that uses this library. It can read
9[Markdown], [CommonMark], [PHP Markdown Extra], [GitHub-Flavored Markdown],
10[MultiMarkdown], and (subsets of) [Textile], [reStructuredText], [HTML],
11[LaTeX], [MediaWiki markup], [TWiki markup], [Haddock markup], [OPML], [Emacs
12Org mode], [DocBook], [txt2tags], [EPUB], [ODT] and [Word docx]; and it can
13write plain text, [Markdown], [CommonMark], [PHP Markdown Extra],
14[GitHub-Flavored Markdown], [MultiMarkdown], [reStructuredText], [XHTML],
15[HTML5], [LaTeX] \(including [`beamer`] slide shows\), [ConTeXt], [RTF], [OPML],
16[DocBook], [OpenDocument], [ODT], [Word docx], [GNU Texinfo], [MediaWiki
17markup], [DokuWiki markup], [ZimWiki markup], [Haddock markup],
18[EPUB] \(v2 or v3\), [FictionBook2], [Textile], [groff man] pages,
19[Emacs Org mode], [AsciiDoc], [InDesign ICML], [TEI Simple], and [Slidy],
20[Slideous], [DZSlides], [reveal.js] or [S5] HTML slide shows. It can also
21produce [PDF] output on systems where LaTeX, ConTeXt, or `wkhtmltopdf` is
24Pandoc's enhanced version of Markdown includes syntax for footnotes, tables,
25flexible ordered lists, definition lists, fenced code blocks, superscripts and
26subscripts, strikeout, metadata blocks, automatic tables of contents, embedded
27LaTeX math, citations, and Markdown inside HTML block elements. (These
28enhancements, described in the manual under *pandoc's Markdown*, can be
29disabled using the `markdown_strict` input or output format.)
31In contrast to most existing tools for converting Markdown to HTML, which
32use regex substitutions, pandoc has a modular design: it consists of a
33set of readers, which parse text in a given format and produce a native
34representation of the document, and a set of writers, which convert
35this native representation into a target format. Thus, adding an input
36or output format requires only adding a reader or writer.
38Because pandoc's intermediate representation of a document is less
39expressive than many of the formats it converts between, one should
40not expect perfect conversions between every format and every other.
41Pandoc attempts to preserve the structural elements of a document, but
42not formatting details such as margin size. And some document elements,
43such as complex tables, may not fit into pandoc's simple document
44model. While conversions from pandoc's Markdown to all formats aspire
45to be perfect, conversions from formats more expressive than pandoc's
46Markdown can be expected to be lossy.
48[Markdown]: http://daringfireball.net/projects/markdown/
49[CommonMark]: http://commonmark.org
50[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
51[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
52[MultiMarkdown]: http://fletcherpenney.net/multimarkdown/
53[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html
54[S5]: http://meyerweb.com/eric/tools/s5/
55[Slidy]: http://www.w3.org/Talks/Tools/Slidy/
56[Slideous]: http://goessner.net/articles/slideous/
57[HTML]: http://www.w3.org/html/
58[HTML5]: http://www.w3.org/TR/html5/
59[XHTML]: http://www.w3.org/TR/xhtml1/
60[LaTeX]: http://latex-project.org
61[`beamer`]: https://ctan.org/pkg/beamer
62[Beamer User's Guide]: http://ctan.math.utah.edu/ctan/tex-archive/macros/latex/contrib/beamer/doc/beameruserguide.pdf
63[ConTeXt]: http://contextgarden.net/
64[RTF]: http://en.wikipedia.org/wiki/Rich_Text_Format
65[DocBook]: http://docbook.org
66[txt2tags]: http://txt2tags.org
67[EPUB]: http://idpf.org/epub
68[OPML]: http://dev.opml.org/spec2.html
69[OpenDocument]: http://opendocument.xml.org
70[ODT]: http://en.wikipedia.org/wiki/OpenDocument
71[Textile]: http://redcloth.org/textile
72[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
73[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
74[ZimWiki markup]: http://zim-wiki.org/manual/Help/Wiki_Syntax.html
75[TWiki markup]: http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
76[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
77[groff man]: http://developer.apple.com/DOCUMENTATION/Darwin/Reference/ManPages/man7/groff_man.7.html
78[Haskell]: https://www.haskell.org
79[GNU Texinfo]: http://www.gnu.org/software/texinfo/
80[Emacs Org mode]: http://orgmode.org
81[AsciiDoc]: http://www.methods.co.nz/asciidoc/
82[DZSlides]: http://paulrouget.com/dzslides/
83[Word docx]: http://www.microsoft.com/interop/openup/openxml/default.aspx
84[PDF]: https://www.adobe.com/pdf/
85[reveal.js]: http://lab.hakim.se/reveal-js/
86[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
87[InDesign ICML]: https://www.adobe.com/content/dam/Adobe/en/devnet/indesign/cs55-docs/IDML/idml-specification.pdf
88[TEI Simple]: https://github.com/TEIC/TEI-Simple
90[](https://www.gnu.org/licenses/gpl.html)
91[](http://hackage.haskell.org/package/pandoc)
92[](http://stackage.org/lts/package/pandoc)
93[](https://github.com/jgm/pandoc/releases)
94[](https://travis-ci.org/jgm/pandoc)
95[](https://ci.appveyor.com/project/jgm/pandoc)
101The full documentation can be found [online](http://pandoc.org/MANUAL.html)
102and as pandoc-flavored Markdown in the file `MANUAL.txt`.
108Pull requests, bug reports, and feature requests are welcome. Please make
109sure to read [the contributor guidelines](CONTRIBUTING.md) before opening a
116© 2006-2016 John MacFarlane (jgm@berkeley.edu). Released under the
117[GPL], version 2 or greater. This software carries no warranty of
118any kind. (See COPYRIGHT for full copyright and warranty notices.)
120[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