git.iko.soy/typeable/pandoc
on 2.7.2 help sign in
typeable/pandoc/README.md
216 lines 10 kB history raw
1<!-- Do not edit this file. It is generated automatically from
2README.template and MANUAL.txt via the command:
3pandoc --lua-filter tools/update-readme.lua README.template -o README.md
4-->
6# Pandoc
8[![github
9release](https://img.shields.io/github/release/jgm/pandoc.svg?label=current+release)](https://github.com/jgm/pandoc/releases)
10[![hackage
11release](https://img.shields.io/hackage/v/pandoc.svg?label=hackage)](http://hackage.haskell.org/package/pandoc)
12[![homebrew](https://img.shields.io/homebrew/v/pandoc.svg)](http://brewformulas.org/Pandoc)
13[![stackage LTS
14package](http://stackage.org/package/pandoc/badge/lts)](http://stackage.org/lts/package/pandoc)
15[![CircleCI](https://circleci.com/gh/jgm/pandoc.svg?style=svg)](https://circleci.com/gh/jgm/pandoc)
16[![appveyor build
17status](https://ci.appveyor.com/api/projects/status/nvqs4ct090igjiqc?svg=true)](https://ci.appveyor.com/project/jgm/pandoc)
18[![license](https://img.shields.io/badge/license-GPLv2+-lightgray.svg)](https://www.gnu.org/licenses/gpl.html)
19[![pandoc-discuss on google
20groups](https://img.shields.io/badge/pandoc-discuss-red.svg?style=social)](https://groups.google.com/forum/#!forum/pandoc-discuss)
22## The universal markup converter
24Pandoc is a [Haskell](http://haskell.org) library for converting from
25one markup format to another, and a command-line tool that uses this
26library. It can convert *from*
28<div id="input-formats">
30 - `commonmark` ([CommonMark](http://commonmark.org) Markdown)
31 - `creole` ([Creole 1.0](http://www.wikicreole.org/wiki/Creole1.0))
32 - `docbook` ([DocBook](http://docbook.org))
33 - `docx` ([Word docx](https://en.wikipedia.org/wiki/Office_Open_XML))
34 - `dokuwiki` ([DokuWiki markup](https://www.dokuwiki.org/dokuwiki))
35 - `epub` ([EPUB](http://idpf.org/epub))
36 - `fb2`
37 ([FictionBook2](http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1)
38 e-book)
39 - `gfm` ([GitHub-Flavored
40 Markdown](https://help.github.com/articles/github-flavored-markdown/)),
41 or the deprecated and less accurate `markdown_github`; use
42 [`markdown_github`](#markdown-variants) only if you need extensions
43 not supported in [`gfm`](#markdown-variants).
44 - `haddock` ([Haddock
45 markup](https://www.haskell.org/haddock/doc/html/ch03s08.html))
46 - `html` ([HTML](http://www.w3.org/html/))
47 - `ipynb` ([Jupyter
48 notebook](https://nbformat.readthedocs.io/en/latest/))
49 - `jats` ([JATS](https://jats.nlm.nih.gov) XML)
50 - `json` (JSON version of native AST)
51 - `latex` ([LaTeX](http://latex-project.org))
52 - `markdown` ([Pandoc’s Markdown](#pandocs-markdown))
53 - `markdown_mmd`
54 ([MultiMarkdown](http://fletcherpenney.net/multimarkdown/))
55 - `markdown_phpextra` ([PHP Markdown
56 Extra](https://michelf.ca/projects/php-markdown/extra/))
57 - `markdown_strict` (original unextended
58 [Markdown](http://daringfireball.net/projects/markdown/))
59 - `mediawiki` ([MediaWiki
60 markup](https://www.mediawiki.org/wiki/Help:Formatting))
61 - `man` ([roff
62 man](http://man7.org/linux/man-pages/man7/groff_man.7.html))
63 - `muse` ([Muse](https://amusewiki.org/library/manual))
64 - `native` (native Haskell)
65 - `odt` ([ODT](http://en.wikipedia.org/wiki/OpenDocument))
66 - `opml` ([OPML](http://dev.opml.org/spec2.html))
67 - `org` ([Emacs Org mode](http://orgmode.org))
68 - `rst`
69 ([reStructuredText](http://docutils.sourceforge.net/docs/ref/rst/introduction.html))
70 - `t2t` ([txt2tags](http://txt2tags.org))
71 - `textile` ([Textile](http://redcloth.org/textile))
72 - `tikiwiki` ([TikiWiki
73 markup](https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax))
74 - `twiki` ([TWiki
75 markup](http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules))
76 - `vimwiki` ([Vimwiki](https://vimwiki.github.io))
78</div>
80It can convert *to*
82<div id="output-formats">
84 - `asciidoc` ([AsciiDoc](http://www.methods.co.nz/asciidoc/)) or
85 `asciidoctor` ([AsciiDoctor](https://asciidoctor.org/))
86 - `beamer` ([LaTeX beamer](https://ctan.org/pkg/beamer) slide show)
87 - `commonmark` ([CommonMark](http://commonmark.org) Markdown)
88 - `context` ([ConTeXt](http://www.contextgarden.net/))
89 - `docbook` or `docbook4` ([DocBook](http://docbook.org) 4)
90 - `docbook5` (DocBook 5)
91 - `docx` ([Word docx](https://en.wikipedia.org/wiki/Office_Open_XML))
92 - `dokuwiki` ([DokuWiki markup](https://www.dokuwiki.org/dokuwiki))
93 - `epub` or `epub3` ([EPUB](http://idpf.org/epub) v3 book)
94 - `epub2` (EPUB v2)
95 - `fb2`
96 ([FictionBook2](http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1)
97 e-book)
98 - `gfm` ([GitHub-Flavored
99 Markdown](https://help.github.com/articles/github-flavored-markdown/)),
100 or the deprecated and less accurate `markdown_github`; use
101 [`markdown_github`](#markdown-variants) only if you need extensions
102 not supported in [`gfm`](#markdown-variants).
103 - `haddock` ([Haddock
104 markup](https://www.haskell.org/haddock/doc/html/ch03s08.html))
105 - `html` or `html5` ([HTML](http://www.w3.org/html/),
106 i.e. [HTML5](http://www.w3.org/TR/html5/)/XHTML [polyglot
107 markup](https://www.w3.org/TR/html-polyglot/))
108 - `html4` ([XHTML](http://www.w3.org/TR/xhtml1/) 1.0 Transitional)
109 - `icml` ([InDesign
110 ICML](http://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf))
111 - `ipynb` ([Jupyter
112 notebook](https://nbformat.readthedocs.io/en/latest/))
113 - `jats` ([JATS](https://jats.nlm.nih.gov) XML)
114 - `json` (JSON version of native AST)
115 - `latex` ([LaTeX](http://latex-project.org))
116 - `man` ([roff
117 man](http://man7.org/linux/man-pages/man7/groff_man.7.html))
118 - `markdown` ([Pandoc’s Markdown](#pandocs-markdown))
119 - `markdown_mmd`
120 ([MultiMarkdown](http://fletcherpenney.net/multimarkdown/))
121 - `markdown_phpextra` ([PHP Markdown
122 Extra](https://michelf.ca/projects/php-markdown/extra/))
123 - `markdown_strict` (original unextended
124 [Markdown](http://daringfireball.net/projects/markdown/))
125 - `mediawiki` ([MediaWiki
126 markup](https://www.mediawiki.org/wiki/Help:Formatting))
127 - `ms` ([roff
128 ms](http://man7.org/linux/man-pages/man7/groff_ms.7.html))
129 - `muse` ([Muse](https://amusewiki.org/library/manual)),
130 - `native` (native Haskell),
131 - `odt` ([OpenOffice text
132 document](http://en.wikipedia.org/wiki/OpenDocument))
133 - `opml` ([OPML](http://dev.opml.org/spec2.html))
134 - `opendocument` ([OpenDocument](http://opendocument.xml.org))
135 - `org` ([Emacs Org mode](http://orgmode.org))
136 - `plain` (plain text),
137 - `pptx`
138 ([PowerPoint](https://en.wikipedia.org/wiki/Microsoft_PowerPoint)
139 slide show)
140 - `rst`
141 ([reStructuredText](http://docutils.sourceforge.net/docs/ref/rst/introduction.html))
142 - `rtf` ([Rich Text
143 Format](http://en.wikipedia.org/wiki/Rich_Text_Format))
144 - `texinfo` ([GNU Texinfo](http://www.gnu.org/software/texinfo/))
145 - `textile` ([Textile](http://redcloth.org/textile))
146 - `slideous` ([Slideous](http://goessner.net/articles/slideous/) HTML
147 and JavaScript slide show)
148 - `slidy` ([Slidy](http://www.w3.org/Talks/Tools/Slidy/) HTML and
149 JavaScript slide show)
150 - `dzslides` ([DZSlides](http://paulrouget.com/dzslides/) HTML5 +
151 JavaScript slide show),
152 - `revealjs` ([reveal.js](http://lab.hakim.se/reveal-js/) HTML5 +
153 JavaScript slide show)
154 - `s5` ([S5](http://meyerweb.com/eric/tools/s5/) HTML and JavaScript
155 slide show)
156 - `tei` ([TEI Simple](https://github.com/TEIC/TEI-Simple))
157 - `xwiki` ([XWiki
158 markup](https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/XWikiSyntax/))
159 - `zimwiki` ([ZimWiki
160 markup](http://zim-wiki.org/manual/Help/Wiki_Syntax.html))
161 - the path of a custom lua writer, see [Custom
162 writers](#custom-writers) below
164</div>
166Pandoc can also produce PDF output via LaTeX, Groff ms, or HTML.
168Pandoc’s enhanced version of Markdown includes syntax for tables,
169definition lists, metadata blocks, footnotes, citations, math, and much
170more. See the User’s Manual below under [Pandoc’s
171Markdown](https://pandoc.org/MANUAL.html#pandocs-markdown).
173Pandoc has a modular design: it consists of a set of readers, which
174parse text in a given format and produce a native representation of the
175document (an *abstract syntax tree* or AST), and a set of writers, which
176convert this native representation into a target format. Thus, adding an
177input or output format requires only adding a reader or writer. Users
178can also run custom pandoc filters to modify the intermediate AST (see
179the documentation for [filters](https://pandoc.org/filters.html) and
180[lua filters](https://pandoc.org/lua-filters.html)).
182Because pandoc’s intermediate representation of a document is less
183expressive than many of the formats it converts between, one should not
184expect perfect conversions between every format and every other. Pandoc
185attempts to preserve the structural elements of a document, but not
186formatting details such as margin size. And some document elements, such
187as complex tables, may not fit into pandoc’s simple document model.
188While conversions from pandoc’s Markdown to all formats aspire to be
189perfect, conversions from formats more expressive than pandoc’s Markdown
190can be expected to be lossy.
192## Installing
194Here’s [how to install pandoc](INSTALL.md).
196## Documentation
198Pandoc’s website contains a full [User’s
199Guide](https://pandoc.org/MANUAL.html). It is also available
200[here](MANUAL.txt) as pandoc-flavored Markdown. The website also
201contains some [examples of the use of
202pandoc](https://pandoc.org/demos.html) and a limited [online
203demo](https://pandoc.org/try).
205## Contributing
207Pull requests, bug reports, and feature requests are welcome. Please
208make sure to read [the contributor guidelines](CONTRIBUTING.md) before
209opening a new issue.
211## License
213© 2006-2018 John MacFarlane (jgm@berkeley.edu). Released under the
214[GPL](http://www.gnu.org/copyleft/gpl.html "GNU General Public License"),
215version 2 or greater. This software carries no warranty of any kind.
216(See COPYRIGHT for full copyright and warranty notices.)