forked from hswaw/hscloud
q3k
8adbd49051
Change-Id: Ib9830c66fe36c423d38f447905c470b67cde5399 |
||
|---|---|---|
| .. | ||
| config | ||
| source | ||
| tpl | ||
| BUILD.bazel | ||
| README.md | ||
| helpers.go | ||
| main.go | ||
| markdown.go | ||
README.md
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.
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
masterbranch - https://hackdoc.hackerspace.pl/?ref=change/249 for the the source code at change '249'
Local Rendering
To run hackdoc locally on a filesystem checkout (ie. when working on docs, templates, or hackdoc itself), run:
bazel run //devtools/hackdoc -- -hspki_disable -docroot /path/to/hscloud
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.