Skip to content

About

Everything regarding makeing documentation easy. ๐Ÿ“–

Topics

Resources

Security policy

Stars

2 stars

Watchers

1 watching

Forks

Latest commit

ย 

History

201 Commits

Folders and files

NameName
Last commit message
Last commit date
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

DocumANTation logo: an open book with the ant as its figure

DocumANTation

One brand, one toolchain โ†’ book, slides, PowerPoint, CV and a docs site. Containerized, reproducible, pixel-perfect.

Linux x64 Docs

Docs site

Formulate everything in Markdown, use LaTeX's power through Pandoc, and build it in one container. A print-ready book, a Beamer slide deck, a PowerPoint deck, a bilingual CV, a primitives showcase and a Sphinx docs site all take their colours, fonts, code-block palette and author details from a single style/brand.json: change one value, run generate_style.py --write, and every output rebrands at once. The same brand ships as sphinx-kataglyphis-theme, the theme the Kataglyphis docs sites use.

Book title page with desert ant logo Book page with dark code block Beamer slide CV page

Highlights

  • Slides and deck from one source: data/presentation/ renders to Beamer and to pptx, so the two cannot disagree.
  • Brand-consistent code blocks: brand.json โ†’ Pandoc, Pygments, LaTeX and CSS, the same dark palette everywhere.
  • Identity is a token too: author, URL, GitHub handle and institute are generated, never retyped.
  • Containerized builds: one Dockerfile, pinned Pandoc (SHA256-verified) and uv; the host needs only a container runtime.
  • Strict build gates: STRICT_WARNINGS=1 turns Pandoc and LaTeX warnings into failures, locally, since CI compiles no LaTeX.
  • Bilingual CV from one source: CV_LANG=english|german, with cover letters in the same class.

Quick start

git clone --recurse-submodules --branch develop https://github.com/Kataglyphis/DocumANTation.git
cd DocumANTation
nerdctl build . -t pandoc_all            # once; BuildKit must be running
./scripts/build_in_container.sh book     # or beamer, demo, example, pptx, cv, letter

Everything lands in data/out/. With make installed, make book (and every other target) does the same. Prerequisites, every target, live rebuilds and the docs site: docs/getting-started.md.

Documentation

Topic Read
What each output looks like docs/gallery.md
Layout, document types, features, and why not just Pandoc docs/overview.md
Prerequisites, every target, live demo mode, the docs site docs/getting-started.md
The Pandoc and LuaLaTeX stages of each target docs/build-pipeline.md
Tooling, the image's dependencies and their pins docs/project-info.md
The brand and the files generated from it style/README.md
CV profiles and cover letters data/cv/README.md
The Sphinx templates downstream repositories consume docs-tooling/README.md
Reporting a vulnerability SECURITY.md
Rules for agents and contributors AGENTS.md

Contributing and contact

DocumANTation is one of the Kataglyphis repositories, which share one way to contribute and one contact. Licence: MIT, see LICENSE.

About

Everything regarding makeing documentation easy. ๐Ÿ“–

Topics

Resources

Security policy

Stars

2 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages

Generated from Kataglyphis/template