From f6e39ff2a88fb621612598297e8d3cf08eb77988 Mon Sep 17 00:00:00 2001 From: Silvio Rhatto Date: Fri, 23 Aug 2024 13:50:16 -0300 Subject: Feat: MkDocs improvements --- .gitignore | 1 + Makefile | 2 ++ mkdocs.yml | 56 +++++++++++++++++++++++++++++++++++++++++++++++++++++++- 3 files changed, 58 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 006d50c..5d442e9 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,4 @@ /recentchanges /www site +.cache diff --git a/Makefile b/Makefile index dd13f69..6d0a037 100644 --- 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 d0474a3..cabdf69 100644 --- 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 -- cgit v1.2.3