git.iko.soy/typeable/pandoc
on 2.1.3 help sign in
typeable/pandoc/README.md
149 lines 7.4 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[![travis build
16status](https://img.shields.io/travis/jgm/pandoc/master.svg?label=travis+build)](https://travis-ci.org/jgm/pandoc)
17[![appveyor build
18status](https://ci.appveyor.com/api/projects/status/nvqs4ct090igjiqc?svg=true)](https://ci.appveyor.com/project/jgm/pandoc)
19[![license](https://img.shields.io/badge/license-GPLv2+-lightgray.svg)](https://www.gnu.org/licenses/gpl.html)
20[![pandoc-discuss on google
21groups](https://img.shields.io/badge/pandoc-discuss-red.svg?style=social)](https://groups.google.com/forum/#!forum/pandoc-discuss)
23## The universal markup converter
25<div id="description">
27Pandoc is a [Haskell](https://www.haskell.org) library for converting
28from one markup format to another, and a command-line tool that uses
29this library.
31Pandoc can read
32[Markdown](http://daringfireball.net/projects/markdown/),
33[CommonMark](http://commonmark.org), [PHP Markdown
34Extra](https://michelf.ca/projects/php-markdown/extra/),
35[GitHub-Flavored
36Markdown](https://help.github.com/articles/github-flavored-markdown/),
37[MultiMarkdown](http://fletcherpenney.net/multimarkdown/), and (subsets
38of) [Textile](http://redcloth.org/textile),
39[reStructuredText](http://docutils.sourceforge.net/docs/ref/rst/introduction.html),
40[HTML](http://www.w3.org/html/), [LaTeX](http://latex-project.org),
41[MediaWiki markup](https://www.mediawiki.org/wiki/Help:Formatting),
42[TWiki markup](http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules),
43[TikiWiki
44markup](https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax),
45[Creole 1.0](http://www.wikicreole.org/wiki/Creole1.0), [Haddock
46markup](https://www.haskell.org/haddock/doc/html/ch03s08.html),
47[OPML](http://dev.opml.org/spec2.html), [Emacs Org
48mode](http://orgmode.org), [DocBook](http://docbook.org),
49[JATS](https://jats.nlm.nih.gov),
50[Muse](https://amusewiki.org/library/manual),
51[txt2tags](http://txt2tags.org), [Vimwiki](https://vimwiki.github.io),
52[EPUB](http://idpf.org/epub),
53[ODT](http://en.wikipedia.org/wiki/OpenDocument), and [Word
54docx](https://en.wikipedia.org/wiki/Office_Open_XML).
56Pandoc can write plain text,
57[Markdown](http://daringfireball.net/projects/markdown/),
58[CommonMark](http://commonmark.org), [PHP Markdown
59Extra](https://michelf.ca/projects/php-markdown/extra/),
60[GitHub-Flavored
61Markdown](https://help.github.com/articles/github-flavored-markdown/),
62[MultiMarkdown](http://fletcherpenney.net/multimarkdown/),
63[reStructuredText](http://docutils.sourceforge.net/docs/ref/rst/introduction.html),
64[XHTML](http://www.w3.org/TR/xhtml1/),
65[HTML5](http://www.w3.org/TR/html5/), [LaTeX](http://latex-project.org)
66(including [`beamer`](https://ctan.org/pkg/beamer) slide shows),
67[ConTeXt](http://www.contextgarden.net/),
68[RTF](http://en.wikipedia.org/wiki/Rich_Text_Format),
69[OPML](http://dev.opml.org/spec2.html), [DocBook](http://docbook.org),
70[JATS](https://jats.nlm.nih.gov),
71[OpenDocument](http://opendocument.xml.org),
72[ODT](http://en.wikipedia.org/wiki/OpenDocument), [Word
73docx](https://en.wikipedia.org/wiki/Office_Open_XML), [GNU
74Texinfo](http://www.gnu.org/software/texinfo/), [MediaWiki
75markup](https://www.mediawiki.org/wiki/Help:Formatting), [DokuWiki
76markup](https://www.dokuwiki.org/dokuwiki), [ZimWiki
77markup](http://zim-wiki.org/manual/Help/Wiki_Syntax.html), [Haddock
78markup](https://www.haskell.org/haddock/doc/html/ch03s08.html),
79[EPUB](http://idpf.org/epub) (v2 or v3),
80[FictionBook2](http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1),
81[Textile](http://redcloth.org/textile), [groff
82man](http://man7.org/linux/man-pages/man7/groff_man.7.html), [groff
83ms](http://man7.org/linux/man-pages/man7/groff_ms.7.html), [Emacs Org
84mode](http://orgmode.org),
85[AsciiDoc](http://www.methods.co.nz/asciidoc/), [InDesign
86ICML](http://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf),
87[TEI Simple](https://github.com/TEIC/TEI-Simple),
88[Muse](https://amusewiki.org/library/manual),
89[PowerPoint](https://en.wikipedia.org/wiki/Microsoft_PowerPoint) slide
90shows and [Slidy](http://www.w3.org/Talks/Tools/Slidy/),
91[Slideous](http://goessner.net/articles/slideous/),
92[DZSlides](http://paulrouget.com/dzslides/),
93[reveal.js](http://lab.hakim.se/reveal-js/) or
94[S5](http://meyerweb.com/eric/tools/s5/) HTML slide shows. It can also
95produce [PDF](https://www.adobe.com/pdf/) output on systems where LaTeX,
96ConTeXt, `pdfroff`, `wkhtmltopdf`, `prince`, or `weasyprint` is
97installed.
99Pandoc’s enhanced version of Markdown includes syntax for tables,
100definition lists, metadata blocks, `Div` blocks, footnotes and
101citations, embedded LaTeX (including math), Markdown inside HTML block
102elements, and much more. These enhancements, described further under
103Pandoc’s Markdown, can be disabled using the `markdown_strict` format.
105Pandoc has a modular design: it consists of a set of readers, which
106parse text in a given format and produce a native representation of the
107document (like an *abstract syntax tree* or AST), and a set of writers,
108which convert this native representation into a target format. Thus,
109adding an input or output format requires only adding a reader or
110writer. Users can also run custom [pandoc
111filters](http://pandoc.org/filters.html) to modify the intermediate AST.
113Because pandoc’s intermediate representation of a document is less
114expressive than many of the formats it converts between, one should not
115expect perfect conversions between every format and every other. Pandoc
116attempts to preserve the structural elements of a document, but not
117formatting details such as margin size. And some document elements, such
118as complex tables, may not fit into pandoc’s simple document model.
119While conversions from pandoc’s Markdown to all formats aspire to be
120perfect, conversions from formats more expressive than pandoc’s Markdown
121can be expected to be lossy.
123</div>
125## Installing
127Here’s [how to install pandoc](INSTALL.md).
129## Documentation
131Pandoc’s website contains a full [User’s
132Guide](https://pandoc.org/MANUAL.html). It is also available
133[here](MANUAL.txt) as pandoc-flavored Markdown. The website also
134contains some [examples of the use of
135pandoc](https://pandoc.org/demos.html) and a limited [online
136demo](https://pandoc.org/try).
138## Contributing
140Pull requests, bug reports, and feature requests are welcome. Please
141make sure to read [the contributor guidelines](CONTRIBUTING.md) before
142opening a new issue.
144## License
146© 2006-2018 John MacFarlane (jgm@berkeley.edu). Released under the
147[GPL](http://www.gnu.org/copyleft/gpl.html "GNU General Public License"),
148version 2 or greater. This software carries no warranty of any kind.
149(See COPYRIGHT for full copyright and warranty notices.)