aboutsummaryrefslogtreecommitdiff
path: root/INSTALL.md
diff options
context:
space:
mode:
authorJohn MacFarlane <jgm@berkeley.edu>2020-01-15 09:09:34 -0800
committerJohn MacFarlane <jgm@berkeley.edu>2020-01-15 09:09:34 -0800
commit7b339d02a0839909c643f761b29c28cc483ef055 (patch)
treec4eec5f1387774dc7150ef38df9ab25f2125a1de /INSTALL.md
parentebf413cdec8157b96db0e510bc0c15a9e8adf0e3 (diff)
downloadpandoc-7b339d02a0839909c643f761b29c28cc483ef055.tar.gz
Add Docker and GH Actions instructions/links to INSTALL.md.
Diffstat (limited to 'INSTALL.md')
-rw-r--r--INSTALL.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/INSTALL.md b/INSTALL.md
index 3b1047e23..33cc05424 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -142,6 +142,29 @@ device you are using.
- Pandoc is in the [NetBSD] and [FreeBSD ports] repositories.
+## Docker
+
+The official Docker images for pandoc can be found at
+<https://github.com/pandoc/dockerfiles> and at
+[dockerhub](https://hub.docker.com/).
+
+The [pandoc/core](https://hub.docker.com/r/pandoc/core)
+image contains `pandoc` and `pandoc-citeproc`.
+
+The [pandoc/latex](https://hub.docker.com/r/pandoc/latex)
+image also contains the minimal LaTeX installation needed
+to produce PDFs using pandoc.
+
+To run pandoc using Docker, converting `README.md` to `README.pdf`:
+
+ docker run --volume "`pwd`:/data" --user `id -u`:`id -g` pandoc/latex README.md -o README.pdf
+
+## GitHub Actions
+
+Pandoc can be run through
+[GitHub Actions](https://github.com/features/actions). For some
+examples, see <https://github.com/pandoc/pandoc-action-example>.
+
## Compiling from source
If for some reason a binary package is not available for your