Initial tag support

Author: Hecatron

Diff for: .github/workflows/ci.yml

@@ -13,4 +13,5 @@ jobs:
           python-version: 3.x
       - run: pip install mkdocs
       - run: pip install mkdocs-material
+      - run: pip install git+https://github.com/srymh/MkdocsTagPlugin.git@ac1f02ba95527d11d84b5ec87f4e63851d57fc7d
       - run: mkdocs gh-deploy --force

Diff for: docs/Tools_Equipment/Wood_Working/Table_Saw_ts2500.md

@@ -1,3 +1,8 @@
+---
+tags:
+  - Equipment
+---
+
 # TableSaw -  ts 2500
 
 ## features

Diff for: docs/tags/Equipment.md

@@ -0,0 +1,7 @@
+---
+pagetype: tagpage
+---
+
+# Tag: Equipment
+
+This is a test

Diff for: mkdocs.yml

@@ -3,3 +3,6 @@ site_url: https://docs.hacman.org.uk
 repo_url: https://github.com/HACManchester/documentation/
 theme:
  name: material
+ custom_dir: 'theme'
+plugins:
+    - mdoctag

Diff for: theme/main.html

@@ -0,0 +1,20 @@
+{% extends "base.html" %}
+
+{% block site_meta %}
+    {{ super() }}
+    {% if page and page.meta.tags %}
+    {% for tag in page.meta.tags %}
+        <meta name="tag" content="{{ tag }}">
+    {% endfor %}
+    {% endif %}
+{% endblock %}
+
+{% block content %}
+    {{ super() }}
+    {% if page and page.meta.pagetype == 'tagpage' %}
+        {% include "tag_page.html" %}
+    {% endif %}
+    {% if 'mdoctag' in config.plugins %}
+        {% include "tag_list.html" %}
+    {% endif %}
+{% endblock %}

Diff for: theme/tag_list.html

@@ -0,0 +1,28 @@
+{% if page and page.meta.tags %}
+<hr/ >
+<div class="mdoctag-tags-label">Tag</div>
+<div id="mdoctag-tags-list">
+    {% for tag in page.meta.tags %}
+    <a
+        id="{{ 'mdoctag-tag-link-' + tag }}"
+        class="mdoctag-tag-link"
+        href="{{ base_url + '/' +  config.plugins['mdoctag'].config['tagpage_dir'] + '/' + tag }}">
+        {{ tag }}
+    </a>
+    {% endfor %}
+</div>
+<style>
+.mdoctag-tag-link {
+    border: 2px solid;
+    border-radius: 5px;
+    padding: 2px;
+    margin-right: 10px;
+}
+#mdoctag-tags-list {
+    margin-bottom: 20px;
+}
+.mdoctag-tags-label {
+    margin-bottom: 6px;
+}
+</style>
+{% endif %}

Diff for: theme/tag_page.html

@@ -0,0 +1,28 @@
+{% if page %}
+{% set tag = page.file.name %}
+{% set data_file_url = base_url + '/' + config.plugins['mdoctag'].config['data_filename'] %}
+{% endif %}
+
+<div id="mdoctag-tag-page-list"></div>
+
+
+<script>
+    var tag = '{{ tag }}'; // not secure
+    var dataFileURL = '{{ data_file_url }}' // not secure
+    var req = new XMLHttpRequest();
+    req.open('GET', dataFileURL, false);
+    req.send(null);
+    var data = JSON.parse(req.responseText);
+    var filterd = data.filter(function(page) {
+        return page.tags.includes(tag);
+    });
+    html = '<ul>';
+    filterd.forEach(function(page) {
+        var description = page.description.length !== 0 ? page.description : '';
+        html += '<li><a href="' + page.url;
+        html += '">' + page.title;
+        html += '</a>' + ': ' + description + '</li>';
+    });
+    html += '</ul>';
+    document.getElementById('mdoctag-tag-page-list').innerHTML = html;
+</script>

Diff for: virtenv/dev_requirements.txt

@@ -1,3 +1,6 @@
 # Depends
 mkdocs
 mkdocs-material
+
+# Tags for mkdocs
+git+https://github.com/srymh/MkdocsTagPlugin.git@ac1f02ba95527d11d84b5ec87f4e63851d57fc7d