cheshire

hscloud

History

q3k 26f44da5f1 hackdoc: do not add ?ref= to intra-links unless necessary Change-Id: I839863a8c10c54fae11100b885c972bed348eba6		2020-09-23 18:13:20 +00:00
..
config	*: more hackdoc updates	2020-04-10 22:10:18 +02:00
source	devtools/{depotview,hackdoc}: tie both together	2020-04-10 19:24:48 +02:00
tpl	hackdoc: do not render links to pages that wouldn't serve anything	2020-08-10 18:01:13 +02:00
BUILD.bazel	hackdoc: deploy	2020-08-10 18:57:26 +02:00
README.md	*: more hackdoc updates	2020-04-10 22:10:18 +02:00
helpers.go	devtools/{depotview,hackdoc}: tie both together	2020-04-10 19:24:48 +02:00
main.go	devtools/hackdoc: propagate ref in imgs and redirects	2020-04-13 01:35:33 +02:00
markdown.go	hackdoc: do not add ?ref= to intra-links unless necessary	2020-09-23 18:13:20 +00:00

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 master branch
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.