2020-04-08 18:03:12 +00:00
Hackdoc
=======
Hackdoc is a tool to automatically serve documentation based on a checkout of the [hscloud ](/ ) source.
Usage
-----
Any Markdown submitted to hscloud is visible via hackdoc. Simply go to https://hackdoc.hackerspace.pl/path/to/markdown.md to see it rendered.
2020-04-10 15:39:43 +00:00
You can pass a `?ref=foo` URL parameter to a hackdoc URL to get it to render a particular vesrion of the hscloud monorepo. For example:
- https://hackdoc.hackerspace.pl/?ref=master for the `master` branch
- https://hackdoc.hackerspace.pl/?ref=change/249 for the the source code at change '249'
2020-04-08 18:03:12 +00:00
Local Rendering
---------------
To run hackdoc locally on a filesystem checkout (ie. when working on docs, templates, or hackdoc itself), run:
2020-04-10 20:09:35 +00:00
bazel run //devtools/hackdoc:local
2020-04-08 18:03:12 +00:00
The output log should tell you where hackdoc just started listening at. Currently this is `127.0.0.1:8080` by default. You can change this by passing a `-listen` flag, eg. `-listen 127.0.0.1:4242` .