From 4f3840dabfe58027636f3aab38870319ff8417e0 Mon Sep 17 00:00:00 2001 From: Gauthier Provost Date: Thu, 28 Feb 2019 17:24:36 +0800 Subject: [PATCH 1/4] update conf for mkdocs 1.0 and add revision date to pages --- mkdocs.yml | 14 +++++++++++--- theme/main.html | 7 +++++++ 2 files changed, 18 insertions(+), 3 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index e75e0d0..8eb9f73 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -48,12 +48,20 @@ google_analytics: - 'UA-96982596-2' - 'auto' +# Plugins +plugins: + - search + - git-revision-date + # Extensions markdown_extensions: - admonition - - codehilite(guess_lang=false) - - toc(permalink=true) - - lightgallery + - codehilite: + guess_lang: false + - toc: + permalink: true +# - lightgallery + # Page naming pages: 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 %} From 2e336ef13c783e0810b4c9897a98e5c244e3e265 Mon Sep 17 00:00:00 2001 From: Gauthier Provost Date: Mon, 4 Mar 2019 17:24:36 +0800 Subject: [PATCH 2/4] Add note on screw size in wiki assembly page. --- docs/kit.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/kit.md b/docs/kit.md index a6ca6e1..8b585a5 100644 --- a/docs/kit.md +++ b/docs/kit.md @@ -129,6 +129,10 @@ > **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) From 041a10af3c348ffd37d612cc4178840f9c6c55bc Mon Sep 17 00:00:00 2001 From: Gauthier Provost Date: Wed, 17 Jul 2019 12:04:43 +0800 Subject: [PATCH 3/4] update mkdocs config --- mkdocs.yml | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 044ef79..f26e153 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -57,14 +57,13 @@ plugins: markdown_extensions: - admonition - codehilite: - guess_lang: false + guess_lang: False - toc: - permalink: true -# - lightgallery - + permalink: True + - lightgallery # Page naming -pages: +nav: - Introduction: 'index.md' - Kit Assembly: 'kit.md' - Download: 'download.md' From f3f909a49c9aa8a745e88eaad5ce5bf38bd369e9 Mon Sep 17 00:00:00 2001 From: Gauthier Provost Date: Wed, 17 Jul 2019 14:05:17 +0800 Subject: [PATCH 4/4] update README --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) 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