diff --git a/README.md b/README.md index 74d335c..6d2e179 100644 --- a/README.md +++ b/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 diff --git a/docs/kit.md b/docs/kit.md index 22003c5..81e3668 100644 --- a/docs/kit.md +++ b/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) diff --git a/mkdocs.yml b/mkdocs.yml index cc6270e..f26e153 100644 --- a/mkdocs.yml +++ b/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' diff --git a/theme/main.html b/theme/main.html index 023e667..061cc14 100644 --- a/theme/main.html +++ b/theme/main.html @@ -19,3 +19,10 @@ } {% endblock scripts %} + +{% block content %} + {{ super() }} + {% if page.meta.revision_date %} + Updated on {{ page.meta.revision_date }} + {% endif %} +{% endblock %}