Supported tags and respective
1.16.1-frozen(aglio-1.16/Dockerfile) based on
Ubuntuimage. This is Aglio with frozen dependencies.
1.18.0(aglio-1.18/Dockerfile) based on
2.0.0(aglio-2.0/Dockerfile) based on
latest(aglio-2.1/Dockerfile) based on
What is Aglio ?
An API Blueprint renderer that supports multiple themes and outputs static HTML that can be served by any web host. API Blueprint is a Markdown-based document format that lets you write API descriptions and documentation in a simple and straightforward way. Currently supported is API Blueprint format 1A.
What is Docker?
Docker is an open platform for developers and sysadmins to build, ship, and run distributed applications. Consisting of Docker Engine, a portable, lightweight runtime and packaging tool, and Docker Hub, a cloud service for sharing applications and automating workflows, Docker enables apps to be quickly assembled from components and eliminates the friction between development, QA, and production environments. As a result, IT can ship faster and run the same app, unchanged, on laptops, data center VMs, and any cloud.
What is a Docker Image?
Docker images are the basis of containers. Images are read-only, while containers are writeable. Only the containers can be executed by the operating system.
How to use this image?
Method 1: Using the docker image directly
docker run --rm -ti davidonlaptop/aglio
Method 2: Using the provided helper script
By default, when you run aglio inside the container it does not have access to the host's filesystem. To get around this limitation, you can use the helper script.
First, install the script in your path. This script will launch aglio in a new Docker container that mounts the path
$HOME/tmp/aglio inside the container so you can use this path for Aglio's input/output files.
echo export PATH="$HOME/bin:$PATH" >> $HOME/.bashrc echo export AGLIO_VOLUME="$HOME/tmp/aglio" >> $HOME/.bashrc source $HOME/.bashrc cp aglio.sh $HOME/bin/aglio
You only need to do the steps above once.
Then, you can run aglio as follow (directly on the host):
aglio -i $AGLIO_VOLUME/blueprint.md -o $AGLIO_VOLUME/output.html