Git Product home page Git Product logo

alpine-pandoc's Introduction

alpine-pandoc

MicroBadger Size (tag) MicroBadger Layers (tag) Docker Pulls Docker Stars

This is the source code which builds a Docker container comprised of Alpine Linux, Pandoc, and PlantUML. It is intended to provide an environment which is optimized for generating documentation.

We use:

Building the Container

make

Consuming the Container

The short version is FROM skyzyx/alpine-pandoc:1.2.0.

  1. Compiling Pandoc takes some time, so using this container saves you that time.
  2. Build your own container with your own specific dependencies using RUN commands.
  3. Use something like Docker Compose to mount your documentation source to /var/docs.
  4. Add your documentation-building task as an ENTRYPOINT.

docker-compose up the first time (or with --build) will build your custom container, then run your ENTRYPOINT task. Subsequent runs of docker-compose up will only execute your ENTRYPOINT task.

Sample Dockerfile

Using Sphinx

FROM skyzyx/alpine-pandoc:1.2.0

ENV PERSISTENT_DEPS wget git mercurial make openssh sphinx
ENV SPHINXBUILD /usr/bin/sphinx-build
ENV SPHINXOPTS -T

# Copy Source code and set working directory
COPY src /var/docs
WORKDIR /var/docs

USER root

RUN apk add --no-cache --virtual .persistent-deps $PERSISTENT_DEPS
RUN pip install -r requirements.txt

ENTRYPOINT ["make", "docs"]
FROM skyzyx/alpine-pandoc:1.2.0

USER root
ENV DEPS \
    make \
    texlive-xetex
RUN apk add --no-cache $DEPS && \
    pip install pandoc-plantuml-filter

USER pandoc
ENTRYPOINT ["make", "docs"]

# make ultimately calls:
#  pandoc --filter=pandoc-plantuml
#         --output=out.pdf
#         --from=markdown
#         *.md

Sample docker-compose.yml

version: "3"
services:
    documentation-builder:
        build: .
        volumes:
            - ./src:/var/docs

alpine-pandoc's People

Contributors

duncanvr avatar skyzyx avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.