diff options
| author | Pedro Alvarez <pedro.alvarez@codethink.co.uk> | 2016-02-29 20:18:23 +0000 |
|---|---|---|
| committer | Baserock Gerrit <gerrit@baserock.org> | 2016-02-29 20:18:23 +0000 |
| commit | 51196d28f1cbfba2f4289175d53ae80e404c0425 (patch) | |
| tree | 22e6c9e6f0f0b4b372a8b318831869a4cf54b8b4 /README.mdwn | |
| parent | 8a32abdedbd1c203100cfe10018356f90be10412 (diff) | |
| parent | 29457450049b50dca16b33d65ef6dfff2d92d27c (diff) | |
| download | spec-51196d28f1cbfba2f4289175d53ae80e404c0425.tar.gz | |
Merge "Allow rendering the spec as a website"
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 ------------ |