Documentation

Updated: Jan 02, 2020 by Pradeep Gowda.

What nobody tells you about documentation - Blog - Divio

BrachioGraph - the cheapest, simplest possible pen-plotter — BrachioGraph 0.1 documentation references the above style.

fnm/docs at master · Schniz/fnm – a good example of how to use a shell script along with asciinema to record a CLI session to use as a “show and tell”. Outputs the session as svg file, which can then be embeded in a web page / README.md.

bep/docuapi: Beautiful multilingual API documentation theme for Hugo. This theme is built on top of the beautiful work of Robert Lord and others on the Slate project (Apache 2 License). Demo Site

Mallard
  • is for writing documentation
  • Mallard documents are topic-oriented: They provide information in small chunks that match your users’ needs without forcing them to read lengthy manuals. Mallard comes in two flavors: traditional XML, and the lightweight syntax Ducktype.