about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
authorsterni <sternenseemann@systemli.org>2021-03-10T14·37+0100
committersterni <sternenseemann@systemli.org>2021-03-11T13·12+0000
commit2cd2b58a04cd86e8bf1d72e9c0a67ad8c8e9c8dd (patch)
tree3f31e27a700d93ec79bd2e130dc98ebc1eda024e /README.md
parente41bd6a82de9f9cba1783fc26bb71b4c97b1953a (diff)
feat(users/sterni/htmlman): static site generator for manual pages r/2276
htmlman is a very simple nix based static site generator which is
intended for rendering HTML representations for man pages plus an index
page listing all available pages. For the sake of simplicity (and unlike
previous iterations of this piece of code) other documentation artifacts
and formats are not supported.

Usually web services like GitHub and depot's web interface are pretty
good at displaying "normal" documentation artifacts like markdown files,
but man pages are usually not rendered — with the additional problem
that it's source is virtually unreadable. htmlman should provide a
simple static site generator which can be plugged into GitHub actions or
the like to automatically generate rendered version of man pages tracked
in version control.

Change-Id: Ib53292964b3ff84c32d70c5fde257a2edb8c2122
Reviewed-on: https://cl.tvl.fyi/c/depot/+/2596
Tested-by: BuildkiteCI
Reviewed-by: tazjin <mail@tazj.in>
Reviewed-by: Profpatsch <mail@profpatsch.de>
Reviewed-by: sterni <sternenseemann@systemli.org>
Diffstat (limited to 'README.md')
0 files changed, 0 insertions, 0 deletions