https://github.com/groovytron/pandoc-container

Container embedding pandoc and some pandoc filters to build documentation
https://github.com/groovytron/pandoc-container

docker documentation documentation-tool hacktoberfest kroki pandoc

Last synced: over 1 year ago
JSON representation

Container embedding pandoc and some pandoc filters to build documentation

• Host: GitHub
• URL: https://github.com/groovytron/pandoc-container
• Owner: groovytron
• License: mit
• Created: 2019-04-23T16:38:07.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2020-04-05T13:10:48.000Z (about 6 years ago)
• Last Synced: 2025-01-06T21:15:37.549Z (over 1 year ago)
• Topics: docker, documentation, documentation-tool, hacktoberfest, kroki, pandoc
• Language: Dockerfile
• Homepage:
• Size: 50.8 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Pandoc container

[![Build Status](https://travis-ci.org/groovytron/pandoc-container.svg?branch=master)](https://travis-ci.org/groovytron/pandoc-container)

Container embedding pandoc and some pandoc filter to convert files from a format to another.

## Supported tags and respective `Dockerfile` links

- `2.9`, `latest` ([2.9/Dockerfile](https://github.com/groovytron/pandoc-container/blob/master/2.9/Dockerfile))

- `2.8` ([2.8/Dockerfile](https://github.com/groovytron/pandoc-container/blob/master/2.8/Dockerfile))

- `2.7` ([2.7/Dockerfile](https://github.com/groovytron/pandoc-container/blob/master/2.7/Dockerfile))

## Softwares embedded in the container

- [curl](https://curl.haxx.se) to generate diagrams using a tool like [kroki](https://github.com/yuzutech/kroki)

- [inotify-tools](https://github.com/rvoicilas/inotify-tools) if you want to [rebuild your documentation on every file change with inotifywait](https://stackoverflow.com/a/23734495)

- `make`

- [pandoc](https://pandoc.org)

- [pandoc-crossref](https://github.com/lierdakil/pandoc-crossref) filter

- [pandoc-include-code](https://github.com/owickstrom/pandoc-include-code) filter

## Use the container

We recommend you to use the `dev` user instead of `root` when running that container.

The container's working directory is `/home/dev/doc` so we advise you to mount your project's documentation directory onto this place.

### Building the project interactively in the container

To run the container and open a bash in your documentation project run the following command:

`docker run -it --entrypoint /bin/bash --user=dev --volume=:/home/dev/doc groovytron/pandoc:latest`