tree: df1836899d6cb87d984b005d4ccc7b4fd6248f6b [path history] [tgz]
  1. config/
  2. source/
  3. tpl/
  4. BUILD.bazel
  5. helpers.go
  6. main.go
  7. markdown.go
  8. README.md
devtools/hackdoc/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.