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

• bibtex (BibTeX bibliography)
• biblatex (BibLaTeX bibliography)
• bits (BITS XML, alias
  for jats)
• commonmark (CommonMark Markdown)
• commonmark_x (CommonMark Markdown with
  extensions)
• creole (Creole 1.0)
• csljson (CSL
  JSON
  bibliography)
• csv (CSV table)
• tsv
  (TSV
  table)
• djot (Djot markup)
• docbook (DocBook)
• docx (Word docx)
• dokuwiki (DokuWiki markup)
• endnotexml (EndNote XML
  bibliography)
• epub (EPUB)
• fb2
  (FictionBook2
  e-book)
• gfm (GitHub-Flavored
  Markdown),
  or the deprecated and less accurate markdown_github; use
  markdown_github
  only if you need extensions not supported in
  gfm.
• haddock (Haddock
  markup)
• html (HTML)
• ipynb (Jupyter
  notebook)
• jats (JATS XML)
• jira
  (Jira/Confluence
  wiki markup)
• json (JSON version of native AST)
• latex (LaTeX)
• markdown (Pandocs
  Markdown)
• markdown_mmd
  (MultiMarkdown)
• markdown_phpextra (PHP Markdown
  Extra)
• markdown_strict (original unextended
  Markdown)
• mediawiki (MediaWiki
  markup)
• man (roff man)
• muse (Muse)
• native (native Haskell)
• odt (OpenOffice text
  document)
• opml (OPML)
• org (Emacs Org mode)
• ris (RIS
  bibliography)
• rtf (Rich Text
  Format)
• rst
  (reStructuredText)
• t2t (txt2tags)
• textile (Textile)
• tikiwiki (TikiWiki
  markup)
• twiki (TWiki
  markup)
• typst (typst)
• vimwiki (Vimwiki)
• the path of a custom Lua reader, see Custom readers and
  writers
  below

It can convert to

• ansi (text with ANSI escape
  codes, for terminal
  viewing)
• asciidoc (modern AsciiDoc as interpreted by
  AsciiDoctor)
• asciidoc_legacy (AsciiDoc as interpreted by
  asciidoc-py).
• asciidoctor (deprecated synonym for asciidoc)
• beamer (LaTeX beamer slide show)
• bibtex (BibTeX bibliography)
• biblatex (BibLaTeX bibliography)
• chunkedhtml (zip archive of multiple linked HTML files)
• commonmark (CommonMark Markdown)
• commonmark_x (CommonMark Markdown with
  extensions)
• context (ConTeXt)
• csljson (CSL
  JSON
  bibliography)
• djot (Djot markup)
• docbook or docbook4 (DocBook 4)
• docbook5 (DocBook 5)
• docx (Word docx)
• dokuwiki (DokuWiki markup)
• epub or epub3 (EPUB v3 book)
• epub2 (EPUB v2)
• fb2
  (FictionBook2
  e-book)
• gfm (GitHub-Flavored
  Markdown),
  or the deprecated and less accurate markdown_github; use
  markdown_github
  only if you need extensions not supported in
  gfm.
• haddock (Haddock
  markup)
• html or html5 (HTML,
  i.e.HTML5/XHTML polyglot
  markup)
• html4 (XHTML 1.0 Transitional)
• icml (InDesign
  ICML)
• ipynb (Jupyter
  notebook)
• jats_archiving (JATS XML, Archiving and
  Interchange Tag Set)
• jats_articleauthoring (JATS XML, Article
  Authoring Tag Set)
• jats_publishing (JATS XML, Journal
  Publishing Tag Set)
• jats (alias for jats_archiving)
• jira
  (Jira/Confluence
  wiki markup)
• json (JSON version of native AST)
• latex (LaTeX)
• man (roff man)
• markdown (Pandocs
  Markdown)
• markdown_mmd
  (MultiMarkdown)
• markdown_phpextra (PHP Markdown
  Extra)
• markdown_strict (original unextended
  Markdown)
• markua (Markua)
• mediawiki (MediaWiki
  markup)
• ms (roff ms)
• muse (Muse)
• native (native Haskell)
• odt (OpenOffice text
  document)
• opml (OPML)
• opendocument (OpenDocument)
• org (Emacs Org mode)
• pdf (PDF)
• plain (plain text)
• pptx
  (PowerPoint
  slide show)
• rst
  (reStructuredText)
• rtf (Rich Text
  Format)
• texinfo (GNU Texinfo)
• textile (Textile)
• slideous (Slideous HTML
  and JavaScript slide show)
• slidy (Slidy HTML and
  JavaScript slide show)
• dzslides (DZSlides HTML5 +
  JavaScript slide show)
• revealjs (reveal.js HTML5 + JavaScript
  slide show)
• s5 (S5 HTML and JavaScript
  slide show)
• tei (TEI Simple)
• typst (typst)
• xwiki (XWiki
  markup)
• zimwiki (ZimWiki
  markup)
• the path of a custom Lua writer, see Custom readers and
  writers
  below

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

Pandocs enhanced version of Markdown includes syntax for tables, definition lists, metadata blocks, footnotes, citations, math, and much more. See the Users Manual below under Pandocs 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 pandocs 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 pandocs simple document model. While conversions from pandocs Markdown to all formats aspire to be perfect, conversions from formats more expressive than pandocs Markdown can be expected to be lossy.

Installing

Heres how to install pandoc.

Documentation

Pandocs website contains a full Users 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-2024 John MacFarlane ([email protected]). Released under the GPL, version 2 or greater. This software carries no warranty of any kind. (See COPYRIGHT for full copyright and warranty notices.)