jsseidel/mktechdocs repository overview

⁠Intro

MkTechDocs is a documentation framework created at AT&T Labs⁠ for collating and transforming documents.

⁠Features

Groovy (Java) and Python Jinja2 template support is built into the system, allowing you to add logic into your documentation builds.

Easy to learn. MkTechDocs is an open framework with no "black boxes." Bash, Markdown, HTML, LaTeX, CSS, Python, Groovy, Java.

For simpler projects, configuration consists of nothing more than changing a few variables.

Agile and Continuous Integration friendly.

Use it for building and maintaining large documentation projects or simply to transform and preview a set of documents in a variety of formats.

⁠Documented

Fully documented here: https://att.github.io/MkTechDocs⁠

⁠Sample docker run

⁠Initializing a project

docker run --user $(id -u):$(id -g) --rm --volume $PROJECT:/project jsseidel/mktechdocs

Docker will detect if a mktechdocs.conf file is present. If not, it creates a new, empty project in $PROJECT.

$PROJECT must be an absolute path, not relative.

⁠Building a project

docker run --user $(id -u):$(id -g) --rm --volume $PROJECT:/project jsseidel/mktechdocs

Where $PROJECT is the full path to your MkTechDocs project. $PROJECT must be an absolute path, not relative.

⁠Release notes

0.0.9: Fix for GitHub issues:

• https://github.com/att/MkTechDocs/issues/35⁠
• https://github.com/att/MkTechDocs/issues/34⁠
• https://github.com/att/MkTechDocs/issues/36⁠

Note that these concern PDF features which are not supported in the docker container. However, these fixes will make it easier to port to Ubuntu 20.04.

0.0.8: Fix for GitHub issues:

• https://github.com/att/MkTechDocs/issues/33⁠
• https://github.com/att/MkTechDocs/issues/26⁠

0.0.7: Fix for GitHub issue: https://github.com/att/MkTechDocs/issues/28⁠

0.0.6: Fix for GitHub issue: https://github.com/att/MkTechDocs/issues/24⁠

0.0.5: Fix for GitHub issue: https://github.com/att/MkTechDocs/issues/27⁠

0.0.4: Fix for GitHub issue: https://github.com/att/MkTechDocs/issues/25⁠

0.0.3: Added ability to initialize a new project. Internal changes to prevent PDF builds with docker version.

0.0.2: Internal changes -- upgrade to Ubuntu 18.04 base image, upgrade from python 2 to python 3. Added the ability to make the master document a template (i.e. master.gt) and reworked things to use a semaphore approach to preventing PDF builds in a docker environment (which are not supported)

0.0.1: Initial upload