Feat: MkDocs improvements

diff --git a/.gitignore b/.gitignore
index 3093b79fa3cdad0720caa6b19d92b300f804d244..29cf6139609db73177536eff9a0c59c88acaadba 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -9,3 +9,4 @@ build-area
 puppet/modules
 keyring
 site
+.cache

diff --git a/Makefile b/Makefile
index 94967418bc970a6ebd1c466659ebf1fe1190472e..c7b1cf4fdb09c6445581d80b50fd7b8d616d1e7c 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -22,6 +22,8 @@ web:
 web_deploy:
        @rsync -avz --delete --exclude=keyring site/ debian:/var/sites/debian/www/
 
+docs: web
+
 publish: web web_deploy
 
 keyring:

diff --git a/mkdocs.yml b/mkdocs.yml
index cbd53813cd107263727e0c85d5459c5c130712ea..4b5a5bfdb05c214ed48930a155c9dac376402d58 100644 (file)
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -17,7 +17,61 @@ theme:
   #
   # This option was superseded by the privacy plugin:
   # https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#built-in-privacy-plugin
-  font: false
+  #font: false
+
+# Plugins
+# https://www.mkdocs.org/dev-guide/plugins/
+plugins:
+  # Note that this might not be available in the mkdocs-material package from
+  # Debian bookworm (as of 2024-08-23)
+  privacy: {}
+
+# Markdown extensions
+# See https://www.mkdocs.org/user-guide/configuration/#markdown_extensions
+#     https://squidfunk.github.io/mkdocs-material/setup/extensions/
+markdown_extensions:
+  # Footnotes
+  # https://squidfunk.github.io/mkdocs-material/reference/footnotes/
+  footnotes: {}
+
+  # Tasklist handling
+  # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#tasklist
+  pymdownx.tasklist:
+    custom_checkbox: true
+
+  # SuperFences
+  # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#superfences
+  pymdownx.superfences:
+    custom_fences:
+      - name: mermaid
+        class: mermaid
+        format: !!python/name:pymdownx.superfences.fence_code_format
+
+  # Table of Contents configuration
+  # See https://www.mkdocs.org/user-guide/configuration/#markdown_extensions
+  #     https://www.mkdocs.org/user-guide/writing-your-docs/#linking-to-pages
+  toc:
+    permalink: true
+
+  # Attribute Lists
+  # Needed by proper image handling
+  # https://squidfunk.github.io/mkdocs-material/reference/images/
+  # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#attribute-lists
+  attr_list: {}
+
+  # Markdown in HTML
+  # Needed by proper image handling
+  # https://squidfunk.github.io/mkdocs-material/reference/images/
+  # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#markdown-in-html
+  md_in_html: {}
+
+# Copyright notice
+copyright: Copyleft © 2024 Fluxo Group. See LICENSE for details.
+
+# Extra template parameters
+# https://www.mkdocs.org/user-guide/configuration/#extra
+extra:
+  generator: false
 
 # Navigation
 # https://www.mkdocs.org/user-guide/writing-your-docs/#configure-pages-and-navigation