hscloud/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:

- https://hackdoc.hackerspace.pl/?ref=master for the `master` branch
- https://hackdoc.hackerspace.pl/?ref=change/249 for the the source code at change '249'

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`.
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 18:03:12 +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.`

devtools/{depotview,hackdoc}: tie both together Change-Id: I0a1ca3b4fa0e0a074eccbe0f8748839b926db9c1 2020-04-10 15:39:43 +00:00			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:

			- https://hackdoc.hackerspace.pl/?ref=master for the `master` branch
			`- https://hackdoc.hackerspace.pl/?ref=change/249 for the the source code at change '249'`

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 18:03:12 +00:00			`Local Rendering`
			`---------------`

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

*: more hackdoc updates Change-Id: Ib9830c66fe36c423d38f447905c470b67cde5399 2020-04-10 19:20:53 +00:00			`bazel run //devtools/hackdoc -- -hspki_disable -docroot /path/to/hscloud`
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 18:03:12 +00:00
			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`.