hswaw
/
hscloud
mirror of https://gerrit.hackerspace.pl/hscloud
4
0
Fork 2
Code Actions
hscloud/devtools/hackdoc
History
radex bf4ba488e5 devtools/depotview: migrate away from mirko.libsonnet 
Change-Id: I4ef6e2872e22dff4c3b57e801f8c86b69880835e
Reviewed-on: https://gerrit.hackerspace.pl/c/hscloud/+/1761
Reviewed-by: q3k <q3k@hackerspace.pl>
 		2024-02-04 14:25:57 +00:00
..
config *: enable nogo (go linter) 2024-01-30 22:03:50 +00:00
source go: re-do the entire thing 2023-09-22 21:50:19 +00:00
tpl devtools/hackdoc: fixup rendering on mobile 2021-09-18 20:23:34 +00:00
BUILD.bazel go: re-do the entire thing 2023-09-22 21:50:19 +00:00
README.md go: re-do the entire thing 2023-09-22 21:50:19 +00: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 go: re-do the entire thing 2023-09-22 21:50:19 +00:00
prod.jsonnet devtools/depotview: migrate away from mirko.libsonnet 2024-02-04 14:25:57 +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:

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.