cheshire/hscloud
1
0
Fork 0
forked from hswaw/hscloud
Code Pull requests Activity
hscloud/devtools/hackdoc
History
Sergiusz Bazanski c881cf3c22 devtools/hackdoc: init 
This is hackdoc, a documentation rendering tool for monorepos.

This is the first code iteration, that can only serve from a local git
checkout.

The code is incomplete, and is WIP.

Change-Id: I68ef7a991191c1bb1b0fdd2a8d8353aba642e28f
2020-04-08 20:03:12 +02:00
..
config devtools/hackdoc: init 2020-04-08 20:03:12 +02:00
source devtools/hackdoc: init 2020-04-08 20:03:12 +02:00
tpl devtools/hackdoc: init 2020-04-08 20:03:12 +02:00
BUILD.bazel devtools/hackdoc: init 2020-04-08 20:03:12 +02:00
helpers.go devtools/hackdoc: init 2020-04-08 20:03:12 +02:00
main.go devtools/hackdoc: init 2020-04-08 20:03:12 +02:00
markdown.go devtools/hackdoc: init 2020-04-08 20:03:12 +02:00
README.md devtools/hackdoc: init 2020-04-08 20:03:12 +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.

Local Rendering

To run hackdoc locally on a filesystem checkout (ie. when working on docs, templates, or hackdoc itself), run:

 bazel run //devtools/hackdoc:local

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.