diff options
Diffstat (limited to 'mkdocs.yml')
-rw-r--r-- | mkdocs.yml | 74 |
1 files changed, 73 insertions, 1 deletions
@@ -1,10 +1,80 @@ +# Site parameters site_name: Hydra Suite +# Theme configuration +# See https://www.mkdocs.org/user-guide/choosing-your-theme/ +# https://squidfunk.github.io/mkdocs-material/ theme: - name: readthedocs + # Theme name + name: material + # Logo logo: assets/logo.png + # Do not use external fonts + # Useful for offline operation, GDPR compliance and privacy in general + # See https://squidfunk.github.io/mkdocs-material/setup/changing-the-fonts/#autoloading + # + # This option was superseded by the privacy plugin: + # https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#built-in-privacy-plugin + #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 nav: - index.md - install.md @@ -12,3 +82,5 @@ nav: - tpc.md - backups.md - ideas.md + - todo.md + - changelog.md |