Feat: MkDocs improvements

diff --git a/docs/index.md b/docs/index.md
index 1da4c48e255468a87687094349b97a310c02a4ed..66915c2fadb51a426e08d2ba6e9285a79dc6d594 100644 (file)
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,5 +1,7 @@
 # Hydra Suite - Command and Control
 
+![Hydra](assets/logo.png){ align=left }
+
 Hydra is a suite for orchestration and management of machines composed of
 **lots of conventions and assumptions**, and the following basic commands:
 

diff --git a/mkdocs.yml b/mkdocs.yml
index e9799c308d1766eaa00183685adbc8b5a347a5f6..3837e873a2e40469eb80121b781cb28717ad363f 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