cheshire
/
hscloud
forked from hswaw/hscloud
1
0
Fork 0
Code Pull Requests Activity
hscloud/devtools/hackdoc
History
informatic 94b080d375 devtools/hackdoc: fixup rendering on mobile 
Change-Id: If587defdc0bf1d7c5491c328803289b9e75ba918
Reviewed-on: https://gerrit.hackerspace.pl/c/hscloud/+/1148
Reviewed-by: q3k <q3k@hackerspace.pl>
 		2021-09-18 20:23:34 +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 devtools/hackdoc: fixup rendering on mobile 2021-09-18 20:23:34 +00:00
BUILD.bazel hackdoc: deploy 2020-08-10 18:57:26 +02:00
README.md hackdoc: render TOC inline 2020-09-23 18:13:20 +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 devtools/hackdoc: serve JS with correct mimetype 2021-03-23 15:50:51 +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.