Use this repo to generate HTML-with-PDF documentation for arbitrary collections of Asciidoc and Markdown files.
Conversion is handled by the separate image
gerald1248/asciidoctor, which
derives from the upstream image
asciidoctor/asciidoctor,
adding pandoc
and charting plugins.
To document your own projects, consider including your own Git repositories as git modules in subfolders or simply copy the contents of this folder to the root folder of your repository, taking care not to overwrite files you care about.
The generated HTML page consolidates all images in a single images
folder and ends with a download link to the PDF.
Start by adjusting the file values.json
. It contains the title
of
your project as it will appear at the top of the HTML output and on the
title page of the PDF version. Another key is filename
, which
determines the name of the PDF outputl. (The web page always takes
index.html
.)
{
"title": "Continuous documentation",
"filename": "continuous-documentation",
"substitutions": { (1)
"Fibonacci": "Iccanobif"
}
}
-
This lookup table helps with cross-references and resource paths that would otherwise not be linked correctly. Keys and values represent
find
andreplace
expressions.