diff options
| author | Silvio Rhatto <rhatto@riseup.net> | 2024-08-23 13:50:47 -0300 | 
|---|---|---|
| committer | Silvio Rhatto <rhatto@riseup.net> | 2024-08-23 13:50:47 -0300 | 
| commit | 3bb01bf1067e8730dcd0d61abef0aa64ac8964ea (patch) | |
| tree | 9a796689a0c2d4c21462284d43cd53a182fff3a0 | |
| parent | 54bfba67f7e5dbfbac99268b49c2f524653b9dcb (diff) | |
| download | hydra-3bb01bf1067e8730dcd0d61abef0aa64ac8964ea.tar.gz hydra-3bb01bf1067e8730dcd0d61abef0aa64ac8964ea.tar.bz2  | |
Feat: MkDocs improvements
| -rw-r--r-- | docs/index.md | 2 | ||||
| -rw-r--r-- | mkdocs.yml | 56 | 
2 files changed, 57 insertions, 1 deletions
diff --git a/docs/index.md b/docs/index.md index 1da4c48..66915c2 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,5 +1,7 @@  # Hydra Suite - Command and Control +{ align=left } +  Hydra is a suite for orchestration and management of machines composed of  **lots of conventions and assumptions**, and the following basic commands: @@ -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  | 
