From 5ca3f42e4ed489d61ba8a27e54ca4f222d1b239d Mon Sep 17 00:00:00 2001
From: Justin Campbell <campb303@purdue.edu>
Date: Wed, 23 Dec 2020 10:04:18 -0500
Subject: [PATCH] Add GItHub link and update mkdocs-material config

---
 api/documentation/docs/images/favicon.ico |  1 +
 api/documentation/mkdocs.yml              | 40 ++++++++++++++++++++++-
 2 files changed, 40 insertions(+), 1 deletion(-)
 create mode 120000 api/documentation/docs/images/favicon.ico

diff --git a/api/documentation/docs/images/favicon.ico b/api/documentation/docs/images/favicon.ico
new file mode 120000
index 0000000..19aa1b7
--- /dev/null
+++ b/api/documentation/docs/images/favicon.ico
@@ -0,0 +1 @@
+../../../../public/favicon.ico
\ No newline at end of file
diff --git a/api/documentation/mkdocs.yml b/api/documentation/mkdocs.yml
index cefcc36..af6c5f7 100644
--- a/api/documentation/mkdocs.yml
+++ b/api/documentation/mkdocs.yml
@@ -1,10 +1,48 @@
-site_name: WebQueue2
+################################################################################
+# mkdocs Settings
+# See: https://www.mkdocs.org/user-guide/configuration/
+################################################################################
 
+site_name: webqueue2 API
+repo_url: https://github.itap.purdue.edu/ECN/webqueue2
+plugins:
+  - search
 markdown_extensions:
+  - toc:
+      permalink: ⚓︎
   - admonition
   - codehilite
   - mkautodoc
 
+
+
+################################################################################
+# Material for mkdocs Settings
+# See: https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/
+################################################################################
+
+# TODO: Implement offline search
+# See: https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#offline-search
+# TODO: Implement versioning
+# See: https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/#versioning
+
 theme:
   name: material
+  palette:
+    primary: deep purple
+    accent: teal
+  icon:
+    logo: material/book-open
+  # The favicon is symlinked from the ReactJS public folder
+  favicon: images/favicon.ico
+  features:
+    - navigation.sections
 
+extra:
+  social:
+    - icon: fontawesome/brands/slack
+      link: https://purdueecn.slack.com/archives/C019K7PSPNW
+      name: webqueue2 on Slack
+    - icon: fontawesome/brands/github
+      link: https://github.itap.purdue.edu/ECN/webqueue2
+      name: webqueue2 on GitHub
\ No newline at end of file