pandoc/core

Sponsored OSS

By pandoc

Updated about 7 hours ago

Official pandoc image with image conversion tools and pandoc-crossref.

Image
Languages & Frameworks
Integration & Delivery

1M+

Core pandoc images

These images contain pandoc, the universal document converter, and a minimal operating system with all tools required for common conversion tasks.

E.g., the images also contain a program to convert SVG graphics (svg-convert), as well as the pandoc-crossref filter, often used to number figures, equations, tables and to cross-reference them.

Quick Reference

Supported tags

  • edge
  • 3.6.3.0, 3.6.3, 3.6, 3, latest
  • 3.5.0.0, 3.5.0, 3.5
  • 3.2.1.0, 3.2.1, 3.2

The tags listed in a bullet point all refer to the same image. Numerical tags are rolling, meaning that a version tag always points to the newest image with the given version prefix. A prefix-version like a.b. is an easy way to specify a range of acceptable versions. Use a full, four part version like a.b.c.d to fix the image to a specific version.

The latest tag refers to the most recently released version; there may be a minor lag between the time a pandoc version is released and a new image is released.

A recent development version is provided under the edge tag.

All tags can be suffixed with a stack identifier.

A note on pandoc versioning

Pandoc is not only an executable but also a Haskell library, which is why it is versioned using the Haskell Package Versioning Policy. Even minor versions can sometimes introduce new behavior if the API does not change, but this is a rare occasion.

Supported stacks

All tags can be suffixed with a stack-identifier, e.g., latest-ubuntu. This allows to chose a specific operation system. Available stacks are

The default for pandoc/core is alpine.

Run the pandoc Docker container

A common use of the image looks like this (linebreaks for readability):

docker run --rm \
       --volume "$(pwd):/data" \
       --user $(id -u):$(id -g) \
       pandoc/core README.md -o outfile.epub

This will convert the file README.md in the current working directory into outfile.epub. Note that Docker options go before the image name, here pandoc/core, while pandoc options come after it.

The --volume flag maps some local directory (lefthand side of the colons) to a directory in the container (righthand side), so that you have your source files available for pandoc to convert. $(pwd) is quoted to protect against spaces in filenames.

Ownership of the output file is determined by the user executing pandoc in the container. This will generally be a user different from the local user. It is hence a good idea to specify for docker the user and group IDs to use via the --user flag.

For frequent command line use, we suggest the following shell alias:

alias pandock=\
'docker run --rm -v "$(pwd):/data" -u $(id -u):$(id -g) pandoc/core'

Other images

The following pandoc images are available:

Docker Pull Command

docker pull pandoc/core