diff options
| author | Sam Thursfield <sam.thursfield@codethink.co.uk> | 2016-02-29 17:28:24 +0000 |
|---|---|---|
| committer | Sam Thursfield <sam.thursfield@codethink.co.uk> | 2016-02-29 18:30:44 +0000 |
| commit | 29457450049b50dca16b33d65ef6dfff2d92d27c (patch) | |
| tree | 18a55db70be62aba2c08c48a394a91e62093aa31 /README.mdwn | |
| parent | 4c2678539ac71e8cdbce883c2e805c2666511ad0 (diff) | |
| download | spec-29457450049b50dca16b33d65ef6dfff2d92d27c.tar.gz | |
Allow rendering the spec as a website
The website isn't too pretty so far (especially when Javascript is
disabled), help welcome on that front. It should be usable though.
You can install mkdocs and the mkdocs-material theme from PyPI, then
run `mkdocs serve` to test changes locally.
Change-Id: Iaa33f936310f6e126f50e095e0b924babbdd8540
Diffstat (limited to 'README.mdwn')
| -rw-r--r-- | README.mdwn | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/README.mdwn b/README.mdwn index c49202c..66702d5 100644 --- a/README.mdwn +++ b/README.mdwn @@ -13,6 +13,18 @@ The definitions format is documentated as a Markdown text file. See that text for more information about the Baserock definitions format. +The contents of the 'master' branch is rendered as HTML at +<http://docs.baserock.org/>. This is done using the 'mkdocs' static site +generator. + +If you want to try out changes to the HTML rendering locally, install +mkdocs and the required theme, then run `mkdocs serve` from the root +directory of the repository. For example: + + pip3.4 install --user mkdocs mkdocs-material + mkdocs serve + # Rendered content should now be visible at http://localhost:8000/ + JSON-Schemas ------------ |