add: material template

KnowledgeCaptureAndDiscovery · Feb 14, 2020 · e8f53ed · e8f53ed
1 parent af4b3fd
commit e8f53ed
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 3 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -0,0 +1,15 @@
+# Required
+version: 2
+
+# Build documentation with MkDocs
+mkdocs:
+  configuration: mkdocs.yml
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats: all
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+  version: 3.7
+  install:
+    - requirements: docs/requirements.txt
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1 @@
+mkdocs-material
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -4,6 +4,12 @@ nav:
   - Quickstart: quickstart.md
   - OBA features: features.md
   - Configuration file: configuration_file.md
-theme: readthedocs
-markdown_extensions:
-  - admonition
+  theme:
+    name: material
+
+  markdown_extensions:
+    - admonition
+    - codehilite:
+        guess_lang: false
+    - toc:
+        permalink: true