pandoc: Conversion between markup formats
Pandoc is a Haskell library for converting from one markup format to another, and a command-line tool that uses this library. It can read several dialects of Markdown and (subsets of) HTML, reStructuredText, LaTeX, DocBook, MediaWiki markup, TWiki markup, Haddock markup, OPML, Emacs Org-Mode, txt2tags, Word Docx, ODT, and Textile, and it can write Markdown, reStructuredText, XHTML, HTML 5, LaTeX, ConTeXt, DocBook, OPML, TEI, OpenDocument, ODT, Word docx, RTF, MediaWiki, DokuWiki, ZimWiki, Textile, groff man pages, plain text, Emacs Org-Mode, AsciiDoc, Haddock markup, EPUB (v2 and v3), FictionBook2, InDesign ICML, and several kinds of HTML/javascript slide shows (S5, Slidy, Slideous, DZSlides, reveal.js).
In contrast to most existing tools for converting Markdown to HTML, pandoc has a modular design: it consists of a set of readers, which parse text in a given format and produce a native representation of the document, and a set of writers, which convert this native representation into a target format. Thus, adding an input or output format requires only adding a reader or writer.
[Skip to Readme]
| Versions | 0.4, 0.41, 0.42, 0.43, 0.44, 0.45, 0.46, 1.0, 1.0.0.1, 1.1, 1.2, 1.2.1, 1.3, 1.4, 1.5, 1.5.0.1, 1.5.1, 1.5.1.1, 1.6, 1.6.0.1, 1.8, 1.8.0.1, 1.8.0.2, 1.8.0.3, 1.8.1, 1.8.1.1, 1.8.1.2, 1.8.2, 1.8.2.1, 1.9, 1.9.0.2, 1.9.0.3, 1.9.0.4, 1.9.0.5, 1.9.1, 1.9.1.1, 1.9.1.2, 1.9.2, 1.9.3, 1.9.4, 1.9.4.1, 1.9.4.2, 1.9.4.3, 1.9.4.4, 1.9.4.5, 1.10, 1.10.0.1, 1.10.0.2, 1.10.0.3, 1.10.0.4, 1.10.0.5, 1.10.1, 1.11, 1.11.1, 1.12, 1.12.0.1, 1.12.0.2, 1.12.1, 1.12.2, 1.12.2.1, 1.12.3, 1.12.3.1, 1.12.3.2, 1.12.3.3, 1.12.4, 1.12.4.2, 1.13, 1.13.0.1, 1.13.1, 1.13.2, 1.13.2.1, 1.14, 1.14.0.1, 1.14.0.2, 1.14.0.3, 1.14.0.4, 1.14.1, 1.15, 1.15.0.1, 1.15.0.2, 1.15.0.3, 1.15.0.4, 1.15.0.5, 1.15.0.6, 1.15.1, 1.15.1.1, 1.15.2, 1.15.2.1, 1.16, 1.16.0.1, 1.16.0.2, 1.17, 1.17.0.1, 1.17.0.2, 1.17.0.3, 1.17.1, 1.17.2, 1.18, 1.19, 1.19.1, 1.19.2, 1.19.2.1, 1.19.2.2, 1.19.2.3, 1.19.2.4, 2.0, 2.0.0.1, 2.0.1, 2.0.1.1, 2.0.2, 2.0.3, 2.0.4, 2.0.5, 2.0.6, 2.1, 2.1.1, 2.1.2, 2.1.3, 2.2, 2.2.1 (info) |
|---|---|
| Change log | changelog |
| Dependencies | aeson (>=0.7.0.5 && <1.2), array (>=0.3 && <0.6), base (>=4.7 && <5), base64-bytestring (>=0.1 && <1.1), binary (>=0.5 && <0.10), blaze-html (>=0.5 && <0.10), blaze-markup (>=0.5.1 && <0.9), bytestring (>=0.9 && <0.11), cmark (==0.5.*), containers (>=0.1 && <0.6), data-default (>=0.4 && <0.8), deepseq (>=1.3 && <1.5), directory (>=1.2 && <1.4), doctemplates (==0.1.*), extensible-exceptions (==0.1.*), filemanip (==0.3.*), filepath (>=1.1 && <1.5), ghc-prim (>=0.2), haddock-library (>=1.1 && <1.5), hslua (>=0.3 && <0.5), HTTP (>=4000.0.5 && <4000.4), http-client (>=0.4.30 && <0.6), http-client-tls (>=0.2.4 && <0.4), http-types, JuicyPixels (>=3.1.6.1 && <3.3), mtl (==2.2.*), network (>=2), network-uri (==2.6.*), old-locale (>=1 && <1.1), old-time, pandoc, pandoc-types (>=1.17 && <1.17.1), parsec (==3.1.*), process (>=1 && <1.7), random (>=1 && <1.2), scientific (>=0.2 && <0.4), SHA (==1.6.*), skylighting (>=0.1.1.5 && <0.2), syb (>=0.1 && <0.8), tagsoup (>=0.13.7 && <0.15), temporary (>=1.1 && <1.3), texmath (==0.9.*), text (>=0.11 && <1.3), time (>=1.2 && <1.9), unix (>=2.4 && <2.8), unordered-containers (==0.2.*), vector (>=0.10 && <0.13), wai (>=0.3), wai-extra, weigh (==0.0.*), xml (>=1.3.12 && <1.4), yaml (>=0.8.8.2 && <0.9), zip-archive (>=0.2.3.4 && <0.4), zlib (>=0.5 && <0.7) [details] |
| License | LicenseRef-GPL |
| Copyright | (c) 2006-2017 John MacFarlane |
| Author | John MacFarlane <jgm@berkeley.edu> |
| Maintainer | John MacFarlane <jgm@berkeley.edu> |
| Category | Text |
| Home page | http://pandoc.org |
| Bug tracker | https://github.com/jgm/pandoc/issues |
| Source repo | head: git clone git://github.com/jgm/pandoc.git |
| Uploaded | by JohnMacFarlane at Sat Sep 9 00:39:47 UTC 2017 |
| Distributions | Arch:2.2.1, Debian:1.16.0.2, Fedora:2.0.6, FreeBSD:1.15.0.6, LTSHaskell:2.1.2, NixOS:2.2.1, Stackage:2.2.1, openSUSE:2.1.2 |
| Executables | weigh-pandoc, trypandoc, pandoc |
| Downloads | 132444 total (1297 in the last 30 days) |
| Rating | 2.75 (votes: 13) [estimated by rule of succession] |
| Your Rating | |
| Status | Docs available [build log] Last success reported on 2017-09-09 [all 1 reports] Hackage Matrix CI |
Modules
[Index]
- Text
- Text.Pandoc
- Text.Pandoc.CSS
- Text.Pandoc.Error
- Text.Pandoc.MediaBag
- Text.Pandoc.Options
- Text.Pandoc.PDF
- Text.Pandoc.Pretty
- Text.Pandoc.Process
- Readers
- Text.Pandoc.Readers.CommonMark
- Text.Pandoc.Readers.DocBook
- Text.Pandoc.Readers.Docx
- Text.Pandoc.Readers.EPUB
- Text.Pandoc.Readers.HTML
- Text.Pandoc.Readers.Haddock
- Text.Pandoc.Readers.LaTeX
- Text.Pandoc.Readers.Markdown
- Text.Pandoc.Readers.MediaWiki
- Text.Pandoc.Readers.Native
- Text.Pandoc.Readers.OPML
- Text.Pandoc.Readers.Odt
- Text.Pandoc.Readers.Org
- Text.Pandoc.Readers.RST
- Text.Pandoc.Readers.TWiki
- Text.Pandoc.Readers.TeXMath
- Text.Pandoc.Readers.Textile
- Text.Pandoc.Readers.Txt2Tags
- Text.Pandoc.SelfContained
- Text.Pandoc.Shared
- Text.Pandoc.Templates
- Text.Pandoc.UTF8
- Writers
- Text.Pandoc.Writers.AsciiDoc
- Text.Pandoc.Writers.CommonMark
- Text.Pandoc.Writers.ConTeXt
- Text.Pandoc.Writers.Custom
- Text.Pandoc.Writers.Docbook
- Text.Pandoc.Writers.Docx
- Text.Pandoc.Writers.DokuWiki
- Text.Pandoc.Writers.EPUB
- Text.Pandoc.Writers.FB2
- Text.Pandoc.Writers.HTML
- Text.Pandoc.Writers.Haddock
- Text.Pandoc.Writers.ICML
- Text.Pandoc.Writers.LaTeX
- Text.Pandoc.Writers.Man
- Text.Pandoc.Writers.Markdown
- Text.Pandoc.Writers.MediaWiki
- Text.Pandoc.Writers.Native
- Text.Pandoc.Writers.ODT
- Text.Pandoc.Writers.OPML
- Text.Pandoc.Writers.OpenDocument
- Text.Pandoc.Writers.Org
- Text.Pandoc.Writers.RST
- Text.Pandoc.Writers.RTF
- Text.Pandoc.Writers.TEI
- Text.Pandoc.Writers.Texinfo
- Text.Pandoc.Writers.Textile
- Text.Pandoc.Writers.ZimWiki
- Text.Pandoc.XML
- Text.Pandoc
Flags
| Name | Description | Default | Type |
|---|---|---|---|
| embed_data_files | Embed data files in binary for relocatable executable. | Disabled | Automatic |
| trypandoc | Build trypandoc cgi executable. | Disabled | Automatic |
| weigh-pandoc | Build weigh-pandoc to measure memory usage. | Disabled | Automatic |
| https | Enable support for downloading of resources over https. | Enabled | Automatic |
| network-uri | Get Network.URI from the network-uri package | Enabled | Automatic |
| old-locale | Use old-locale and time < 1.5 | Disabled | Automatic |
Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info
Downloads
- pandoc-1.19.2.3.tar.gz [browse] (Cabal source package)
- Package description (as included in the package)
Readme for pandoc-1.19.2.3
[back to package description]Pandoc
The universal markup converter
Pandoc is a Haskell library for converting from one markup format to
another, and a command-line tool that uses this library. It can read
Markdown, CommonMark, PHP Markdown Extra, GitHub-Flavored Markdown,
MultiMarkdown, and (subsets of) Textile, reStructuredText, HTML,
LaTeX, MediaWiki markup, TWiki markup, Haddock markup, OPML, Emacs
Org mode, DocBook, txt2tags, EPUB, ODT and Word docx; and it can
write plain text, Markdown, CommonMark, PHP Markdown Extra,
GitHub-Flavored Markdown, MultiMarkdown, reStructuredText, XHTML,
HTML5, LaTeX (including beamer slide shows), ConTeXt, RTF, OPML,
DocBook, OpenDocument, ODT, Word docx, GNU Texinfo, MediaWiki
markup, DokuWiki markup, ZimWiki markup, Haddock markup,
EPUB (v2 or v3), FictionBook2, Textile, groff man pages,
Emacs Org mode, AsciiDoc, InDesign ICML, TEI Simple, and Slidy,
Slideous, DZSlides, reveal.js or S5 HTML slide shows. It can also
produce PDF output on systems where LaTeX, ConTeXt, or wkhtmltopdf is
installed.
Pandoc's enhanced version of Markdown includes syntax for footnotes,
tables, flexible ordered lists, definition lists, fenced code blocks,
superscripts and subscripts, strikeout, metadata blocks, automatic tables of
contents, embedded LaTeX math, citations, and Markdown inside HTML block
elements. (These enhancements, described
further under Pandoc's Markdown, can be disabled using the
markdown_strict input or output format.)
In contrast to most existing tools for converting Markdown to HTML, which use regex substitutions, pandoc has a modular design: it consists of a set of readers, which parse text in a given format and produce a native representation of the document, and a set of writers, which convert this native representation into a target format. Thus, adding an input or output format requires only adding a reader or writer.
Because pandoc's intermediate representation of a document is less expressive than many of the formats it converts between, one should not expect perfect conversions between every format and every other. Pandoc attempts to preserve the structural elements of a document, but not formatting details such as margin size. And some document elements, such as complex tables, may not fit into pandoc's simple document model. While conversions from pandoc's Markdown to all formats aspire to be perfect, conversions from formats more expressive than pandoc's Markdown can be expected to be lossy.
Installing
Here's how to install pandoc.
Documentation
Pandoc's website contains a full User's Guide. It is also available here as pandoc-flavored Markdown. The website also contains some examples of the use of pandoc and a limited online demo.
Contributing
Pull requests, bug reports, and feature requests are welcome. Please make sure to read the contributor guidelines before opening a new issue.
License
© 2006-2016 John MacFarlane (jgm@berkeley.edu). Released under the GPL, version 2 or greater. This software carries no warranty of any kind. (See COPYRIGHT for full copyright and warranty notices.)