pandoc: Conversion between markup formats

[ gpl, library, program, text ] [ Propose Tags ]

Pandoc is a Haskell library for converting from one markup format to another, and a command-line tool that uses this library. The formats it can handle include

  • light markup formats (many variants of Markdown, reStructuredText, AsciiDoc, Org-mode, Muse, Textile, txt2tags)

  • HTML formats (HTML 4 and 5)

  • Ebook formats (EPUB v2 and v3, FB2)

  • Documentation formats (GNU TexInfo, Haddock)

  • Roff formats (man, ms)

  • TeX formats (LaTeX, ConTeXt)

  • XML formats (DocBook 4 and 5, JATS, TEI Simple, OpenDocument)

  • Outline formats (OPML)

  • Bibliography formats (BibTeX, BibLaTeX, CSL JSON, CSL YAML)

  • Word processor formats (Docx, RTF, ODT)

  • Interactive notebook formats (Jupyter notebook ipynb)

  • Page layout formats (InDesign ICML)

  • Wiki markup formats (MediaWiki, DokuWiki, TikiWiki, TWiki, Vimwiki, XWiki, ZimWiki, Jira wiki, Creole)

  • Slide show formats (LaTeX Beamer, PowerPoint, Slidy, reveal.js, Slideous, S5, DZSlides)

  • Data formats (CSV tables)

  • PDF (via external programs such as pdflatex or wkhtmltopdf)

Pandoc can convert mathematical content in documents between TeX, MathML, Word equations, roff eqn, and plain text. It includes a powerful system for automatic citations and bibliographies, and it can be customized extensively using templates, filters, and custom readers and writers written in Lua.


[Skip to Readme]

Modules

[Index] [Quick Jump]

Flags

Automatic Flags
NameDescriptionDefault
embed_data_files

Embed data files in binary for relocatable executable.

Disabled
lua53

Embed Lua 5.3 instead of 5.4.

Disabled
trypandoc

Build trypandoc cgi executable.

Disabled
nightly

Add '-nightly-COMPILEDATE' to the output of '--version'.

Disabled

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

Downloads

Maintainer's Corner

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 (info)
Change log changelog.md
Dependencies aeson (>=0.7 && <2.2), aeson-pretty (>=0.8.9 && <0.9), array (>=0.5 && <0.6), attoparsec (>=0.12 && <0.15), base (>=4.12 && <5), base64-bytestring (>=0.1 && <1.3), binary (>=0.7 && <0.11), blaze-html (>=0.9 && <0.10), blaze-markup (>=0.8 && <0.9), bytestring (>=0.9 && <0.12), case-insensitive (>=1.2 && <1.3), citeproc (>=0.8.0.1 && <0.9), commonmark (>=0.2.2 && <0.3), commonmark-extensions (>=0.2.3.1 && <0.3), commonmark-pandoc (>=0.2.1.2 && <0.3), connection (>=0.3.1), containers (>=0.6.0.1 && <0.7), data-default (>=0.4 && <0.8), deepseq (>=1.3 && <1.5), directory (>=1.2.3 && <1.4), doclayout (>=0.4 && <0.5), doctemplates (>=0.10 && <0.11), emojis (>=0.1 && <0.2), exceptions (>=0.8 && <0.11), file-embed (>=0.0 && <0.1), filepath (>=1.1 && <1.5), Glob (>=0.7 && <0.11), gridtables (>=0.0.2 && <0.1), haddock-library (>=1.10 && <1.11), hslua (>=2.1 && <2.2 || >=2.2.1 && <2.3), hslua-aeson (>=2.2.1 && <2.3), hslua-module-doclayout (>=1.0.4 && <1.1), hslua-module-path (>=1.0 && <1.1), hslua-module-system (>=1.0 && <1.1), hslua-module-text (>=1.0 && <1.1), hslua-module-version (>=1.0 && <1.1), http-client (>=0.4.30 && <0.8), http-client-tls (>=0.2.4 && <0.4), http-types (>=0.8 && <0.13), ipynb (>=0.2 && <0.3), jira-wiki-markup (>=1.4 && <1.5), JuicyPixels (>=3.1.6.1 && <3.4), lpeg (>=1.0.1 && <1.1), mtl (>=2.2 && <2.3), network (>=2.6), network-uri (>=2.6 && <2.8), pandoc, pandoc-lua-marshal (>=0.1.7 && <0.2), pandoc-types (>=1.22.2 && <1.23), parsec (>=3.1 && <3.2), pretty (>=1.1 && <1.2), pretty-show (>=1.10 && <1.11), process (>=1.2.3 && <1.7), random (>=1 && <1.3), safe (>=0.3.18 && <0.4), scientific (>=0.3 && <0.4), SHA (>=1.6 && <1.7), skylighting (>=0.13 && <0.14), skylighting-core (>=0.13 && <0.14), split (>=0.2 && <0.3), syb (>=0.1 && <0.8), tagsoup (>=0.14.6 && <0.15), template-haskell, temporary (>=1.1 && <1.4), texmath (>=0.12.5.1 && <0.12.6), text (>=1.1.1.0 && <2.1), text-conversions (>=0.3 && <0.4), time (>=1.5 && <1.14), unicode-collation (>=0.1.1 && <0.2), unicode-transforms (>=0.3 && <0.5), unix (>=2.4 && <2.8), wai (>=0.3), wai-extra (>=3.0.24), xml (>=1.3.12 && <1.4), xml-conduit (>=1.9.1.1 && <1.10), xml-types (>=0.3 && <0.4), yaml (>=0.11 && <0.12), zip-archive (>=0.2.3.4 && <0.5), zlib (>=0.5 && <0.7) [details]
License GPL-2.0-or-later
Copyright (c) 2006-2022 John MacFarlane
Author John MacFarlane <jgm@berkeley.edu>
Maintainer John MacFarlane <jgm@berkeley.edu>
Category Text
Home page https://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 2022-08-04T06:09:10Z
Distributions Arch:2.18, Debian:2.9.2.1, Fedora:2.14.0.3, FreeBSD:1.15.0.6, LTSHaskell:2.17.1.1, NixOS:2.17.1.1, Stackage:2.18, openSUSE:2.17.1.1
Executables trypandoc, pandoc
Downloads 314258 total (945 in the last 30 days)
Rating 2.75 (votes: 20) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs uploaded by user
Build status unknown [no reports yet]

Readme for pandoc-2.19

[back to package description]

Pandoc

githubrelease hackagerelease homebrew stackage LTSpackage CItests license pandoc-discuss on googlegroups

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 convert from

It can convert to

Pandoc can also produce PDF output via LaTeX, Groff ms, or HTML.

Pandoc’s enhanced version of Markdown includes syntax for tables, definition lists, metadata blocks, footnotes, citations, math, and much more. See the User’s Manual below under Pandoc’s Markdown.

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 (an abstract syntax tree or AST), 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. Users can also run custom pandoc filters to modify the intermediate AST (see the documentation for filters and Lua filters).

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-2022 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.)