summaryrefslogtreecommitdiff
path: root/mkdocs.yml
diff options
context:
space:
mode:
Diffstat (limited to 'mkdocs.yml')
-rw-r--r--mkdocs.yml28
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'