|
@@ -44,27 +44,26 @@ Markdown (*.md) files.
|
|
|
|
|
|
# Generating man pages from the Markdown files
|
|
|
|
|
|
-The recommended approach for generating the man pages is via a Docker
|
|
|
-container. Using the supplied Dockerfile, Docker will create a Fedora based
|
|
|
-container and isolate the Pandoc installation. This is a seamless process,
|
|
|
-saving you from dealing with Pandoc and dependencies on your own computer.
|
|
|
+The recommended approach for generating the man pages is via a Docker
|
|
|
+container using the supplied `Dockerfile` to create an image with the correct
|
|
|
+environment. This uses `go-md2man`, a pure Go Markdown to man page generator.
|
|
|
|
|
|
-## Building the Fedora / Pandoc image
|
|
|
+## Building the md2man image
|
|
|
|
|
|
-There is a Dockerfile provided in the `docker/docs/man` directory.
|
|
|
+There is a `Dockerfile` provided in the `docker/docs/man` directory.
|
|
|
|
|
|
-Using this Dockerfile, create a Docker image tagged `fedora/pandoc`:
|
|
|
+Using this `Dockerfile`, create a Docker image tagged `docker/md2man`:
|
|
|
|
|
|
- docker build -t fedora/pandoc .
|
|
|
+ docker build -t docker/md2man .
|
|
|
|
|
|
-## Utilizing the Fedora / Pandoc image
|
|
|
+## Utilizing the image
|
|
|
|
|
|
Once the image is built, run a container using the image with *volumes*:
|
|
|
|
|
|
- docker run -v /<path-to-git-dir>/docker/docs/man:/pandoc:rw \
|
|
|
- -w /pandoc -i fedora/pandoc /pandoc/md2man-all.sh
|
|
|
+ docker run -v /<path-to-git-dir>/docker/docs/man:/docs:rw \
|
|
|
+ -w /docs -i docker/md2man /docs/md2man-all.sh
|
|
|
|
|
|
-The Pandoc Docker container will process the Markdown files and generate
|
|
|
+The `md2man` Docker container will process the Markdown files and generate
|
|
|
the man pages inside the `docker/docs/man/man1` directory using
|
|
|
Docker volumes. For more information on Docker volumes see the man page for
|
|
|
`docker run` and also look at the article [Sharing Directories via Volumes]
|