Merge pull request #154 from mattray/material

Material for MkDocs support

Author: mattray

.circleci/config.yml

@@ -13,7 +13,7 @@ jobs:
       - attach_workspace:
           at: ~/
       - checkout
-      - run: pip install mkdocs
+      - run: pip install mkdocs-material
       - run:
           name: Building package
           command: make build

Dockerfile

@@ -1,6 +1,6 @@
 FROM python:3 AS builder
 
-RUN pip install mkdocs
+RUN pip install mkdocs-material
 
 COPY . /docs
 

README.md

@@ -8,7 +8,7 @@ Install it with:
 pip install mkdocs
 ```
 
-If you have Python3, you may need to run 
+If you have Python3, you may need to run
 
 ```
 pip3 install mkdocs
@@ -23,3 +23,25 @@ mkdocs serve
 ## Changes
 
 Commit your changes and CI will automatically build the new site and deploy it
+
+## Docker Instructions
+
+From the `docs` directory, build the image with the `docs` name.
+
+```
+docker build -t docs .
+```
+
+After a few minutes
+```
+docker images
+REPOSITORY   TAG       IMAGE ID       CREATED              SIZE
+docs         latest    1e704c7ab807   About a minute ago   155MB
+```
+
+Start up the container
+```
+docker run -p 8081:80 docs:latest
+```
+
+and open http://localhost:8081 to view the content.

custom_theme/img/favicon.ico

@@ -1,45 +1,10 @@
-/* We will need to use !important to override default styles */
-body:before {
-  font-family: Roboto, sans-serif;
-  background-color: #fafafa;
-  background-image: none !important;
-}
-
-.bg-primary {
-  background-color: #1976d2 !important;
-  background-image: none !important;
-}
-
-.navbar-brand {
-  font-size: 24px;
-}
-
-.dropdown-item:hover {
-  color: #37474f;
-  background: #eceff1;
-}
-
-.dropdown-item.active {
-  background-color: #e3f2fd;
-  color: #37474f;
-}
-
-#toc-collapse {
-  background-color: white !important;
-}
-
-.nav-link {
-  color: #37474f;
-}
-
-.nav-link:hover {
-  color: #1976d2;
-}
-
-.nav-link.active {
-  color: #1976d2;
-}
-
-a {
-  color: #1976d2;
+:root {
+    --md-accent-fg-color:           #1976d2; /* nav mouseover */
+    --md-default-bg-color:          #fafafa; /* page bg */
+    --md-default-fg-color--light:   #37474f; /* h1 color */
+    --md-default-fg-color--lighter: #e3f2fd; /* pencil color */
+    --md-default-fg-color:          #000000; /* page text */
+    --md-primary-bg-color--light:   #eceff1; /* search panel */
+    --md-primary-bg-color:          #e3f2fd; /* header bg */
+    --md-primary-fg-color:          #1976d2; /* header */
 }

docs/extra.css

@@ -1,4 +1,8 @@
+copyright: © 2021, TriggerMesh
+site_author: TriggerMesh
+site_description: TriggerMesh's Docs
 site_name: TriggerMesh
+site_url: https://docs.triggermesh.io
 repo_url: https://github.com/triggermesh/docs
 google_analytics: ['UA-127409524-1', 'docs.triggermesh.io']
 extra_css: [extra.css]
@@ -23,8 +27,21 @@ nav:
     - Cloud: https://cloud.triggermesh.io
     - About: about.md
 theme:
-  name: mkdocs
-  custom_dir: "custom_theme/"
+  name: material
+  favicon: images/favicon.ico
+  logo: images/tmLogo-white.png
+
+extra:
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/triggermesh
+      name: TriggerMesh on GitHub
+    - icon: fontawesome/brands/linkedin
+      link: https://www.linkedin.com/company/triggermesh/
+      name: TriggerMesh on LinkedIn
+    - icon: fontawesome/brands/twitter
+      link: https://twitter.com/triggermesh
+      name: TriggerMesh on Twitter
 
 markdown_extensions:
   - attr_list