Feat: MkDocs improvements

diff --git a/.gitignore b/.gitignore
index 006d50c149db9ce2939ff4b13339dbb4336d81a8..5d442e9e69efba7f71ab20b99a64e79881702a60 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -2,3 +2,4 @@
 /recentchanges
 /www
 site
+.cache

diff --git a/Makefile b/Makefile
index dd13f6909f8381d5dbc418d2b1e0c8a41fbcbd62..6d0a0377924345a9db81ffbf9c2da8c93ea22815 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -20,4 +20,6 @@ web:
 web_deploy:
        @rsync -avz --delete site/ padrao:/var/sites/padrao/www/
 
+docs: web
+
 publish: web web_deploy

diff --git a/mkdocs.yml b/mkdocs.yml
index d0474a3e40cc01c5a0e6c9ebd43076485dafc855..cabdf69ff3f079f9faa0030bc37cfb80ef60d543 100644 (file)
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -15,7 +15,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