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 /mkdocs.yml | |
parent | 8a32abdedbd1c203100cfe10018356f90be10412 (diff) | |
parent | 29457450049b50dca16b33d65ef6dfff2d92d27c (diff) | |
download | spec-51196d28f1cbfba2f4289175d53ae80e404c0425.tar.gz |
Merge "Allow rendering the spec as a website"
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' |