From 384503109107e5c3ede0c9abd0b2af6860eb54e6 Mon Sep 17 00:00:00 2001 From: Silvio Rhatto Date: Sat, 14 Sep 2024 10:43:25 -0300 Subject: MkDocs config improvements --- mkdocs.yml | 69 +++++++++++++++++++++++++++++++++++++++++++------------------- 1 file changed, 48 insertions(+), 21 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index eb6d63c..e96188e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -45,15 +45,24 @@ extra_css: - site.css plugins: - #- search - - - macros - - - awesome-pages: - strict: false - #collapse_single_pages: true - - - i18n: + # Search + # See https://www.mkdocs.org/user-guide/configuration/#search + # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/ + #search: {} + + # MkDocs-Macros Plugin + # https://mkdocs-macros-plugin.readthedocs.io + macros: {} + + # Awesome Pages Plugin + # https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin + awesome-pages: + strict: false + #collapse_single_pages: true + + # MkDocs static i18n plugin + # https://github.com/ultrabug/mkdocs-static-i18n + i18n: docs_structure: suffix languages: - locale: en @@ -67,23 +76,41 @@ plugins: Flavors: Sabores Versions: Versões - # In case site structure is needed, this plugin will ensure permalink functionality - #- redirects: - # redirect_maps: - # 'flavors/CC-BY-NC-SA-4.0-FAI.en.md' : variants/CC-BY-NC-SA-4.0-FAI.en.md - # 'flavors/CC-BY-4.0-FAI.en.md' : variants/CC-BY-4.0-FAI.en.md - # 'flavors/CC-BY-4.0-FAI.pt.md' : variants/CC-BY-4.0-FAI.pt.md - # 'flavors/CC-BY-NC-SA-4.0-FAI.pt.md' : variants/CC-BY-NC-SA-4.0-FAI.pt.md - # 'flavors/CC-BY-SA-4.0-FAI.en.md' : variants/CC-BY-SA-4.0-FAI.en.md - # 'flavors/CC-BY-SA-4.0-FAI.pt.md' : variants/CC-BY-SA-4.0-FAI.pt.md + # mkdocs-redirects + # https://github.com/mkdocs/mkdocs-redirects + # In case site re-structure is needed, this plugin will ensure permalink functionality + #redirects: + # redirect_maps: + # 'flavors/CC-BY-NC-SA-4.0-FAI.en.md' : variants/CC-BY-NC-SA-4.0-FAI.en.md + # 'flavors/CC-BY-4.0-FAI.en.md' : variants/CC-BY-4.0-FAI.en.md + # 'flavors/CC-BY-4.0-FAI.pt.md' : variants/CC-BY-4.0-FAI.pt.md + # 'flavors/CC-BY-NC-SA-4.0-FAI.pt.md' : variants/CC-BY-NC-SA-4.0-FAI.pt.md + # 'flavors/CC-BY-SA-4.0-FAI.en.md' : variants/CC-BY-SA-4.0-FAI.en.md + # 'flavors/CC-BY-SA-4.0-FAI.pt.md' : variants/CC-BY-SA-4.0-FAI.pt.md + + # 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: {} markdown_extensions: - - footnotes - - pymdownx.tasklist: - custom_checkbox: true + # 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 notice copyright: Copy Far "AI" 🄯 2023+ +# Extra template parameters +# https://www.mkdocs.org/user-guide/configuration/#extra extra: generator: false -- cgit v1.2.3