There is a package installer at pandoc’s download page.
For PDF output, you’ll also need to install LaTeX. We recommend MiKTeX.
Mac OS X
You can also install pandoc using homebrew:
brew install pandoc.
For PDF output, you’ll also need LaTeX. Because a full MacTeX installation takes more than a gigabyte of disk space, we recommend installing BasicTeX (64M) and using the
tlmgrtool to install additional packages as needed. If you get errors warning of fonts not found, try
tlmgr install collection-fontsrecommended
sudo dpkg -i $DEB
$DEBis the path to the downloaded deb, will will install the
pandoc-citeprocexecutables and man pages. If you use an RPM-based distro, you may be able to install this deb using
alien, or try
ar p $DEB data.tar.gz | sudo tar xvz --strip-components 2 -C /usr/local
If you’d rather install pandoc in your home directory, say in
$HOME/.local, then you can extract the files manually from the deb:
ar p $DEB data.tar.gz | tar xvz --strip-components 2 -C $HOME/.local/
$DEBis the path to the downloaded deb.
If the version in your repository is too old and you cannot use the deb we provide, you can install from source, using the instructions below under [Installing from source]. Note that most distros have the Haskell platform in their package repositories. For example, on Debian/Ubuntu, you can install it with
apt-get install haskell-platform.
For PDF output, you’ll need LaTeX. We recommend installing TeX Live via your package manager. (On Debian/Ubuntu,
apt-get install texlive.)
Compiling from source
If for some reason a binary package is not available for your platform, or if you want to hack on pandoc or use a non-released version, you can install from source.
Getting the pandoc source code
Source tarballs can be found at https://hackage.haskell.org/package/pandoc. For example, to fetch the source for version 184.108.40.206:
wget https://hackage.haskell.org/package/pandoc-220.127.116.11/pandoc-18.104.22.168.tar.gz tar xvzf pandoc-22.214.171.124.tar.gz cd pandoc-126.96.36.199
Or you can fetch the development code by cloning the repository:
git clone https://github.com/jgm/pandoc cd pandoc git submodule update --init # to fetch the templates
Note: there may be times when the development code is broken or depends on other libraries which must be installed separately. Unless you really know what you’re doing, install the last released version.
Quick stack method
The easiest way to build pandoc from source is to use stack:
Change to the pandoc source directory and issue the following commands:
stack setup stack install --test
stack setupwill automatically download the ghc compiler if you don’t have it.
stack installwill install the
~/.local/bin, which you should add to your
PATH. This process will take a while, and will consume a considerable amount of disk space.
Quick cabal method
Update your package database:
cabalto install pandoc and its dependencies:
cabal install pandoc --enable-tests
This procedure will install the released version of pandoc, which will be downloaded automatically from HackageDB.
If you want to install a modified or development version of pandoc instead, switch to the source directory and do as above, but without the ‘pandoc’:
Note: If you obtained the source from the git repository (rather than a release tarball), you’ll need to do
git submodule update --init
to fetch the contents of
Make sure the
$CABALDIR/bindirectory is in your path. You should now be able to run
If you want to process citations with pandoc, you will also need to install a separate package,
pandoc-citeproc. This can be installed using cabal:
cabal install pandoc-citeproc
pandoc-citeprocuses the “i;unicode-casemap” method to sort bibliography entries (RFC 5051). If you would like to use the locale-sensitive unicode collation algorithm instead, specify the
cabal install pandoc-citeproc -funicode_collation
Note that this requires the
text-iculibrary, which in turn depends on the C library
icu4c. Installation directions vary by platform. Here is how it might work on OSX with homebrew:
brew install icu4c cabal install –extra-lib-dirs=/usr/local/Cellar/icu4c/51.1/lib
-funicode_collation text-icu pandoc-citeproc
pandoc.1man page will be installed automatically. cabal shows you where it is installed: you may need to set your
MANUAL.txthas been modified, the man page can be rebuilt:
pandoc-citeproc.1man page will also be installed automatically.
Custom cabal method
This is a step-by-step procedure that offers maximal control over the build and installation. Most users should use the quick install, but this information may be of use to packagers. For more details, see the Cabal User’s Guide. These instructions assume that the pandoc source directory is your working directory.
Install dependencies: in addition to the Haskell platform, you will need a number of additional libraries. You can install them all with
cabal update cabal install --only-dependencies
cabal configure --prefix=DIR --bindir=DIR --libdir=DIR \ --datadir=DIR --libsubdir=DIR --datasubdir=DIR --docdir=DIR \ --htmldir=DIR --program-prefix=PREFIX --program-suffix=SUFFIX \ --mandir=DIR --flags=FLAGSPEC --enable-tests
All of the options have sensible defaults that can be overridden as needed.
FLAGSPECis a list of Cabal configuration flags, optionally preceded by a
-(to force the flag to
false), and separated by spaces. Pandoc’s flags include:
embed_data_files: embed all data files into the binary (default no). This is helpful if you want to create a relocatable binary. Note: if this option is selected, you need to install the
cabal install hsb2hs(version 0.3.1 or higher is required).
https: enable support for downloading resources over https (using the
cabal build cabal test
Build API documentation:
cabal haddock --html-location=URL --hyperlink-source
Copy the files:
cabal copy --destdir=PATH
The default destdir is
Register pandoc as a GHC package:
Package managers may want to use the
--gen-scriptoption to generate a script that can be run to register the package at install time.
Creating a relocatable binary
It is possible to compile pandoc such that the data files pandoc uses are embedded in the binary. The resulting binary can be run from any directory and is completely self-contained. With cabal, add
-fembed_data_files to the
cabal configure or
cabal install commands.
With stack, use
Pandoc comes with an automated test suite. To run with cabal,
cabal test; to run with stack,
To run particular tests (pattern-matching on their names), use the
cabal test --test-options='-t markdown'
If you add a new feature to pandoc, please add tests as well, following the pattern of the existing tests. The test suite code is in
tests/test-pandoc.hs. If you are adding a new reader or writer, it is probably easiest to add some data files to the
tests directory, and modify
tests/Tests/Old.hs. Otherwise, it is better to modify the module under the
tests/Tests hierarchy corresponding to the pandoc module you are changing.
To build and run the benchmarks:
cabal configure --enable-benchmarks && cabal build cabal bench
or with stack:
To use a smaller sample size so the benchmarks run faster:
cabal bench --benchmark-options='-s 20'
To run just the markdown benchmarks:
cabal bench --benchmark-options='markdown'
Building the whole pandoc ecosystem
Sometimes pandoc’s development code depends on unreleased versions of dependent libraries. You’ll need to build these as well. A maximal build method would be
mkdir pandoc-build cd pandoc-build git clone https://github.com/jgm/pandoc-types git clone https://github.com/jgm/texmath git clone https://github.com/jgm/pandoc-citeproc git clone https://github.com/jgm/pandoc git clone https://github.com/jgm/cmark-hs git clone https://github.com/jgm/zip-archive cd pandoc git submodule update --init stack install --test --install-ghc --stack-yaml stack.full.yaml
To pull in the latest changes, after you’ve done this and there have been changes in the repositories: Visit each repository in pandoc-build (pandoc-types, texmath, pandoc-citeproc, pandoc, zip-archive, cmark-hs) and do
git pull. In the pandoc repo, also do
git submodule update and
stack install --test --stack-yaml stack.full.yaml.