cheshire
/
hscloud
forked from hswaw/hscloud
1
0
Fork 0
Code Pull Requests Activity
hscloud/devtools/hackdoc
History
q3k 7b1d137d50 doc: add getting-started/your-first-change 
Change-Id: Ib3d3805507e2cb5ef0194605f081c74719f3b1a3
 		2020-04-13 10:19:38 +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 doc: add getting-started/your-first-change 2020-04-13 10:19:38 +00:00
BUILD.bazel *: more hackdoc updates 2020-04-10 22:10:18 +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 devtools/hackdoc: propagate ref in imgs and redirects 2020-04-13 01:35:33 +02: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:

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.