Merge pull request #17 from helios-4/mkdocs-upgrade

Update conf for mkdocs 1.0 and add revision date to pages

README.md

@@ -13,13 +13,13 @@ Lightgallery : https://github.com/g-provost/lightgallery-markdown
 1. Install mkdocs
 
 ```bash
-$ pip install mkdocs
+$ pip3 install mkdocs
 ```
 
 2. Install Material Template
 
 ```bash
-$ pip install mkdocs-material
+$ pip3 install mkdocs-material
 ```
 
 3. Install Lightgallery Extension
@@ -29,10 +29,16 @@ $ git clone https://github.com/g-provost/lightgallery-markdown.git
 
 $ cd lightgallery-markdown
 
-$ python setup.py install
+$ python3 setup.py install
 ```
 
-4. Download and serve wiki
+4. Install git-revision plugin
+
+```bash
+pip3 install mkdocs-git-revision-date-plugin
+```
+
+5. Download and serve wiki
 
 ```bash
 $ git clone https://github.com/helios-4/wiki.git

docs/kit.md

@@ -142,6 +142,10 @@ Since Helios4 Batch 3 we added to the Kit an OLED Display kit containing
 
 > **Install the standoffs on the board plate using the 5mm long screws.**
 
+
+!!! note
+    Make sure you are using the 5mm long screws and not the 4mm ones which look similar but a bit shorter.
+
 ![Kit Assembly](/img/kit/assembly_pic27.jpg)
 ![Kit Assembly](/img/kit/assembly_pic28.jpg)
 

mkdocs.yml

@@ -48,15 +48,22 @@ google_analytics:
   - 'UA-96982596-2'
   - 'auto'
 
+# Plugins
+plugins:
+  - search
+  - git-revision-date
+
 # Extensions
 markdown_extensions:
   - admonition
-  - codehilite(guess_lang=false)
-  - toc(permalink=true)
+  - codehilite:
+      guess_lang: False
+  - toc:
+      permalink: True
   - lightgallery
 
 # Page naming
-pages:
+nav:
 - Introduction: 'index.md'
 - Kit Assembly: 'kit.md'
 - Download: 'download.md'

theme/main.html

@@ -19,3 +19,10 @@
     }
     </script>
 {% endblock scripts %}
+
+{% block content %}
+    {{ super() }}
+    {% if page.meta.revision_date %}
+    <small><i>Updated on {{ page.meta.revision_date }}</i></small>
+    {% endif %}
+{% endblock %}