Skip to content
Universal markup converter
Haskell Rich Text Format HTML Lua Roff Jupyter Notebook Other
Branch: master
Clone or download
Pull request Compare This branch is 488 commits behind jgm:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
.github
benchmark
data
doc
linux
macos
man
prelude
src/Text
test
tools
trypandoc
windows
.editorconfig
.gitignore
.hlint.yaml
.mailmap
.stylish-haskell.yaml
AUTHORS.md
BUGS
CONTRIBUTING.md
COPYING.md
COPYRIGHT
INSTALL.md
MANUAL.txt
Makefile
README.md
README.template
RELEASE-CHECKLIST
Setup.hs
appveyor.yml
cabal.project
changelog
pandoc.cabal
pandoc.hs
stack.yaml

README.md

Pandoc

github release hackage release homebrew stackage LTS package CircleCI 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 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-2018 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.)

You can’t perform that action at this time.