Enhance acme page.

docs/mkdocs.yml

@@ -9,16 +9,14 @@ repo_url: 'https://github.com/containous/traefik'
 
 docs_dir: 'content'
 
+# https://squidfunk.github.io/mkdocs-material/
 theme:
   name: 'material'
   custom_dir: 'theme'
   language: en
   include_sidebar: true
   favicon: assets/img/traefik.icon.png
   logo: assets/img/traefik.logo.png
-  palette:
-    primary: 'blue'
-    accent: 'light blue'
   feature:
     tabs: false
   palette:
@@ -45,17 +43,21 @@ extra_javascript:
 plugins:
   - search
 
+# https://squidfunk.github.io/mkdocs-material/extensions/admonition/
+# https://facelessuser.github.io/pymdown-extensions/
 markdown_extensions:
   - attr_list
   - admonition
   - footnotes
   - pymdownx.details
   - pymdownx.inlinehilite
   - pymdownx.highlight:
-      use_pygments: false # hljs is used instead of pygment for TOML hihglighting support
+      use_pygments: false # hljs is used instead of pygment for TOML highlighting support
   - pymdownx.smartsymbols
   - pymdownx.superfences
   - pymdownx.tasklist
+  - pymdownx.snippets:
+      check_paths: true
   - markdown_include.include:
       base_path: content/includes/
       encoding: utf-8

docs/readme.md

@@ -0,0 +1,19 @@
+# Documentation
+
+## Tooling
+
+| Tool              | Documentation                       | Sources                           |
+|-------------------|-------------------------------------|-----------------------------------|
+| mkdocs            | [documentation][mkdocs]             | [Sources][mkdocs-src]             |
+| mkdocs-material   | [documentation][mkdocs-material]    | [Sources][mkdocs-material-src]    |
+| pymdown-extensions| [documentation][pymdown-extensions] | [Sources][pymdown-extensions-src] |
+
+
+[mkdocs]: https://www.mkdocs.org "Mkdocs"
+[mkdocs-src]: https://github.com/mkdocs/mkdocs "Mkdocs - Sources"
+
+[mkdocs-material]: https://squidfunk.github.io/mkdocs-material/ "Material for MkDocs"
+[mkdocs-material-src]: https://github.com/squidfunk/mkdocs-material "Material for MkDocs - Sources"
+
+[pymdown-extensions]: https://facelessuser.github.io/pymdown-extensions/extensions "PyMdown Extensions"
+[pymdown-extensions-src]: https://github.com/facelessuser/pymdown-extensions "PyMdown Extensions - Sources"

docs/scripts/verify.sh

@@ -21,7 +21,7 @@ find "${PATH_TO_SITE}" -type f -not -path "/app/site/theme/*" \
   --check_external_hash \
   --alt_ignore="/traefik.logo.png/" \
   --http_status_ignore="0,500,501,503" \
-  --url-ignore "/https://groups.google.com/a/traefik.io/forum/#!forum/security/,/localhost:/,/127.0.0.1:/,/fonts.gstatic.com/,/.minikube/,/github.com\/containous\/traefik\/*edit*/,/github.com\/containous\/traefik\/$/,/docs.traefik.io/" \
+  --url_ignore="/https://groups.google.com/a/traefik.io/forum/#!forum/security/,/localhost:/,/127.0.0.1:/,/fonts.gstatic.com/,/.minikube/,/github.com\/containous\/traefik\/*edit*/,/github.com\/containous\/traefik\/$/,/docs.traefik.io/,/github\.com\/golang\/oauth2\/blob\/36a7019397c4c86cf59eeab3bc0d188bac444277\/.+/" \
   '{}' 1>/dev/null
 ## HTML-proofer options at https://github.com/gjtorikian/html-proofer#configuration
 

docs/theme/main.html

@@ -0,0 +1,37 @@
+{% extends "base.html" %}
+
+{% block footer %}
+
+{% import "partials/language.html" as lang with context %}
+
+<!-- Application footer -->
+<footer class="md-footer">
+
+    <!-- Further information -->
+    <div class="md-footer-meta md-typeset">
+        <div class="md-footer-meta__inner md-grid">
+
+            <!-- Copyright and theme information -->
+            <div class="md-footer-copyright">
+                {% if config.copyright %}
+                <div class="md-footer-copyright__highlight">
+                    {{ config.copyright }}
+                </div>
+                {% endif %}
+                powered by
+                <a href="http://www.mkdocs.org" title="MkDocs">MkDocs</a>
+                and
+                <a href="http://squidfunk.github.io/mkdocs-material/"
+                   title="Material for MkDocs">
+                    Material for MkDocs</a>
+            </div>
+
+            <!-- Social links -->
+            {% block social %}
+            {% include "partials/social.html" %}
+            {% endblock %}
+        </div>
+    </div>
+</footer>
+
+{% endblock %}