Updates MkDocs config

1 files changed, 42 insertions, 1 deletions

diff --git a/mkdocs.yml b/mkdocs.yml
index bbbf2c1..fe674c7 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -2,17 +2,25 @@
 # Mkdocs configuration
 #
 
+# Basic info
 site_name: Protocolos Sociotécnicos
+
+# Folders
 docs_dir : docs
 site_dir : site
 
+# URLs
 repo_url: https://git.fluxo.info/templates
 edit_uri: ''
 
+# Development
 # Site address is bind to 0.0.0.0 so it works find inside a Docker container.
 # A better config would be desirable.
 #dev_addr: '0.0.0.0:8040'
 
+# Theme configuration
+# See https://www.mkdocs.org/user-guide/choosing-your-theme/
+#     https://squidfunk.github.io/mkdocs-material/
 theme:
   name               : material
   collapse_navigation: true
@@ -21,14 +29,35 @@ theme:
   palette:
     primary: blue grey
 
+  # Do not use external fonts
+  # Usefult for offline operation
+  # See https://squidfunk.github.io/mkdocs-material/setup/changing-the-fonts/#autoloading
+  #font: false
+
+# Extra stylesheets
 extra_css:
   - site.css
 
+# Plugins
+# https://www.mkdocs.org/dev-guide/plugins/
 plugins:
+  # Search
+  # See https://www.mkdocs.org/user-guide/configuration/#search
+  #     https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/
   search: {}
 
+  # Awesome Pages Plugin
+  # https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin
   awesome-pages: {}
 
+  # The built-in privacy plugin automatically identifies external assets as
+  # part of the build process and downloads all assets for very simple
+  # self-hosting
+  #
+  # See https://squidfunk.github.io/mkdocs-material/plugins/privacy/
+  #     https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#built-in-privacy-plugin
+  privacy: {}
+
   # BibTeX support using mkdocs-bibtex
   # https://pypi.org/project/mkdocs-bibtex/
   # https://github.com/shyamd/mkdocs-bibtex
@@ -36,6 +65,7 @@ plugins:
   #    bib_dir   : "catalogs/biblio"
   #    csl_file  : "apa.csl"
 
+  # Internationalization
   i18n:
     docs_structure: suffix
     languages:
@@ -49,12 +79,23 @@ plugins:
         nav_translations:
           Provedor: Provider
 
+# 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
 
-copyright: Copyleft © 2023
+# Copyright notice
+copyright: Copyleft © 2024
 
+# Extra template parameters
+# https://www.mkdocs.org/user-guide/configuration/#extra
 extra:
   generator: false