Hackage :: [Package]

pandoc: Conversion between markup formats

[ gpl, library, text ] [ Propose Tags ] [ Report a vulnerability ]

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, TikiWiki markup, Creole 1.0, Haddock markup, OPML, Emacs Org-Mode, Emacs Muse, txt2tags, Vimwiki, Word Docx, ODT, and Textile, and it can write Markdown, reStructuredText, XHTML, HTML 5, LaTeX, ConTeXt, DocBook, JATS, OPML, TEI, OpenDocument, ODT, Word docx, RTF, MediaWiki, DokuWiki, ZimWiki, Textile, groff man, groff ms, plain text, Emacs Org-Mode, AsciiDoc, Haddock markup, EPUB (v2 and v3), FictionBook2, InDesign ICML, Muse, 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]

Modules

[Index]

Flags

Automatic Flags
NameDescriptionDefault
static

Use static linking for pandoc executable.

Disabled
embed_data_files

Embed data files in binary for relocatable executable.

Disabled
trypandoc

Build trypandoc cgi executable.

Disabled
weigh-pandoc

Build weigh-pandoc to measure memory usage.

Disabled
network-uri

Get Network.URI from the network-uri package

Enabled
old-locale

Use old-locale and time < 1.5

Disabled

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

  • No Candidates
Versions [RSS] 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, 2.2.2, 2.2.2.1, 2.2.3, 2.2.3.1, 2.2.3.2, 2.3, 2.3.1, 2.4, 2.5, 2.6, 2.7, 2.7.1, 2.7.2, 2.7.3, 2.8, 2.8.0.1, 2.8.1, 2.9, 2.9.1, 2.9.1.1, 2.9.2, 2.9.2.1, 2.10, 2.10.1, 2.11, 2.11.0.1, 2.11.0.2, 2.11.0.3, 2.11.0.4, 2.11.1, 2.11.1.1, 2.11.2, 2.11.3, 2.11.3.1, 2.11.3.2, 2.11.4, 2.12, 2.13, 2.14, 2.14.0.1, 2.14.0.2, 2.14.0.3, 2.14.1, 2.14.2, 2.15, 2.16, 2.16.1, 2.16.2, 2.17, 2.17.0.1, 2.17.1, 2.17.1.1, 2.18, 2.19, 2.19.1, 2.19.2, 3.0, 3.0.1, 3.1, 3.1.1, 3.1.2, 3.1.3, 3.1.4, 3.1.5, 3.1.6, 3.1.6.1, 3.1.6.2, 3.1.7, 3.1.8, 3.1.9, 3.1.10, 3.1.11, 3.1.11.1, 3.1.12, 3.1.12.1, 3.1.12.2, 3.1.12.3, 3.1.13, 3.2, 3.2.1, 3.3, 3.4, 3.5 (info)
Change log changelog
Dependencies aeson (>=0.7 && <1.3), aeson-pretty (>=0.8 && <0.9), base (>=4.7 && <5), base64-bytestring (>=0.1 && <1.1), binary (>=0.5 && <0.9), blaze-html (>=0.5 && <0.10), blaze-markup (>=0.5.1 && <0.9), bytestring (>=0.9 && <0.11), case-insensitive (>=1.2 && <1.3), cmark-gfm (>=0.1.1 && <0.2), containers (>=0.4.2.1 && <0.6), data-default (>=0.4 && <0.8), deepseq (>=1.3 && <1.5), directory (>=1 && <1.4), doctemplates (>=0.2.1 && <0.3), file-embed (>=0.0 && <0.1), filepath (>=1.1 && <1.5), Glob (>=0.7 && <0.10), haddock-library (>=1.1 && <1.5), hslua (>=0.9 && <0.10), HTTP (>=4000.0.5 && <4000.4), http-client (>=0.4.30 && <0.6), http-client-tls (>=0.2.4 && <0.4), http-types (>=0.8 && <0.10), JuicyPixels (>=3.1.6.1 && <3.3), mtl (>=2.2 && <2.3), network (>=2 && <2.9), network-uri (>=2.6 && <2.7), old-locale (>=1 && <1.1), pandoc, pandoc-types (>=1.17.3 && <1.17.4), parsec (>=3.1 && <3.2), process (>=1.2.3 && <1.7), random (>=1 && <1.2), safe (>=0.3 && <0.4), scientific (>=0.2 && <0.4), SHA (>=1.6 && <1.7), skylighting (>=0.4.3.2 && <0.5), split (>=0.2 && <0.3), syb (>=0.1 && <0.8), tagsoup (>=0.13.7 && <0.15), temporary (>=1.1 && <1.3), texmath (>=0.10 && <0.11), text (>=0.11 && <1.3), time (>=1.2 && <1.9), unix (>=2.4 && <2.8), unordered-containers (>=0.2 && <0.3), vector (>=0.10 && <0.13), wai (>=0.3), wai-extra, weigh (>=0.0 && <0.1), 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]
Tested with ghc ==7.8.4, ghc ==7.10.3, ghc ==8.0.2, ghc ==8.2.1
License LicenseRef-GPL
Copyright (c) 2006-2017 John MacFarlane
Author John MacFarlane <jgm@berkeley.edu>
Maintainer John MacFarlane <jgm@berkeley.edu>
Revised Revision 2 made by HerbertValerioRiedel at 2019-04-26T07:26:05Z
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 2017-11-12T18:06:08Z
Distributions Arch:3.1.11.1, Debian:2.9.2.1, Fedora:3.1.3, FreeBSD:1.15.0.6, LTSHaskell:3.1.11.1, NixOS:3.1.11.1, Stackage:3.5, openSUSE:3.5
Reverse Dependencies 91 direct, 77 indirect [details]
Executables weigh-pandoc, trypandoc, pandoc
Downloads 353291 total (2297 in the last 30 days)
Rating 3.0 (votes: 24) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2017-11-12 [all 1 reports]

Readme for pandoc-2.0.2

[back to package description]

Pandoc

github release hackage release homebrew stackage LTS package travis build status appveyor build status license pandoc-discuss on google groups

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, [TikiWiki markup], Creole 1.0, Haddock markup, OPML, Emacs Org mode, DocBook, Muse, txt2tags, Vimwiki, 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, [groff ms], Emacs Org mode, AsciiDoc, InDesign ICML, TEI Simple, Muse and Slidy, Slideous, DZSlides, reveal.js or S5 HTML slide shows. It can also produce PDF output on systems where LaTeX, ConTeXt, pdfroff, wkhtmltopdf, prince, or weasyprint 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][Extension: markdown_in_html_blocks]. (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-2017 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.)