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 /mkdocs.yml | |
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 'mkdocs.yml')
-rw-r--r-- | mkdocs.yml | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..3c5b7e8 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,28 @@ +# This file controls the HTML rendering of the contents of this repo. +# +# Rendering is done using the 'mkdocs' tool, available from +# <http://www.mkdocs.org/>. + + +site_name: Baserock Project documentation +site_url: https://docs.baserock.org +site_favicon: data/favicon.ico + +copyright: | + Unless otherwise noted, text in this repository is licensed under the + Creative Commons Attribution-ShareAlike 4.0 International license (CC BY-SA + 4.0) + +pages: + - 'index.mdwn' + - 'Definitions format': 'spec.mdwn' + - 'changelog.mdwn' + +docs_dir: . + +site_dir: /srv/docs.baserock.org/ + +# I chose this theme because it mostly functions without Javascript. Many +# of the other mkdocs themes are pretty much unusable for users who have +# Javascript turned off! +theme: 'material' |