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