hscloud/devtools/hackdoc
Serge Bazanski bc0d3cb227 hackdoc: link to cs instead of gitweb
Change-Id: Ifca7a63517bceffe7ccc0452474d9d16626486de
2021-03-06 22:16:54 +00:00
..
config *: more hackdoc updates 2020-04-10 22:10:18 +02:00
source hackdoc: link to cs instead of gitweb 2021-03-06 22:16:54 +00:00
tpl hackdoc: add table css, make it colorful 2020-10-24 20:20:18 +02:00
BUILD.bazel hackdoc: deploy 2020-08-10 18:57:26 +02:00
helpers.go devtools/{depotview,hackdoc}: tie both together 2020-04-10 19:24:48 +02:00
main.go hackdoc: when redirecting, skip ref if default 2021-03-06 22:16:54 +00:00
markdown.go hackdoc: when redirecting, skip ref if default 2021-03-06 22:16:54 +00:00
README.md hackdoc: render TOC inline 2020-09-23 18:13:20 +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.

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:

Special Markdown

We should be accepting a Somewhat Standard Subset Of Markdown. For reference, we're using the blackfriday library with CommonExtensions enabled.

In addition, we also support Table of Contents autorendering, just place the following anywhere in your document to render a TOC:

[TOC]

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 -pub_listen flag, eg. -pub_listen 127.0.0.1:4242.