mastersign/mdproc repository overview

⁠MdProc Container

This image is a prepared environment for running MdProc in a gulp task.

It comes with the necessary tools to build a MdProc based documentation project with all supported output formats (HTML, TEX, PDF, DOCX).

⁠Flavors

To reduce the image size for projects which do not need certain output formats, this image comes in different flavors.

⁠HTML only

mastersign/mdproc:html

• Based on Alpine Linux
• NodeJS with npm
• Gulp
• Bower
• Git
• Pandoc
• Graphviz

⁠DOCX, TEX, HTML

mastersign/mdproc:docx

• Based on Ubuntu
• All tools from mastersign/mdproc:html
• Inkscape

⁠PDF, DOCX, TEX, HTML

mastersign/mdproc:pdf, mastersign/mdproc:latest

• Based on Ubuntu
• All tools from mastersign/mdproc:docx
• TeXLive

⁠CLI Flavors

All flavors come in an additional CLI flavor for usage as CLI tool. These flavors handle the permission issue, when operating on a bind mount.

• mastersign/mdproc:html-cli
• mastersign/mdproc:docx-cli
• mastersign/mdproc:pdf-cli, mastersign/mdproc:cli

⁠Usage as CLI tool

docker run --rm -ti \
    -v ~/my-dock-project:/project \
    -e LOCAL_USER_ID=`id -u $USER`
    mastersign/mdproc:html-cli \
    /usr/bin/run-gulp html

⁠Usage in a CI environment

Just use one of the flavors (non CLI) as the context for the build step, which is executing Gulp.

Example for GitLab CI .gitlab-ci.yml:

image: mastersign/mdproc:pdf
build-docs:
  stage: build
  before_script:
    - "npm install --quiet"
  script: "gulp html pdf"

⁠License

This project is published under the MIT license.

Copyright © by Tobias Kiertscher [email protected]⁠.