From 0894a7b864991d4342b9718f019f46080975aca3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juanjo=20L=C3=B3pez?= Date: Wed, 2 Oct 2024 10:23:43 +0200 Subject: [PATCH] Issue #0: Improved mkdocs.yml with a default structure and addons --- docs/mkdocs.yml | 61 ++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 60 insertions(+), 1 deletion(-) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index b7c6b2e..6c696a7 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -1,6 +1,65 @@ #ddev-generated site_name: Mkdocs site -theme: material dev_addr: '0.0.0.0:8000' +validation: + nav: + omitted_files: warn + not_found: warn + absolute_links: warn + links: + not_found: warn + anchors: warn + absolute_links: warn + unrecognized_links: warn +# More theme options: https://squidfunk.github.io/mkdocs-material/setup/ +theme: + name: material + palette: + primary: purple nav: - Home: index.md +# - Architecture: +# - Content types: +# - Home: architecture/content-types/content-types.md +# - Article: architecture/content-types/article.md +# - Infrastructure: +# - Local: infrastructure/local.md +# - Environments: infrastructure/environments.md +# - Solr: infrastructure/solr.md +# - Features: +# - Search: features/search.md +# - API: features/api.md +# - Procedures: +# - Updates: procedures/updates.md +# - Deployment: procedures/deployment.md +# - Others: +# - Glossary: others/glossary.md +# - FAQ: others/faq.md +markdown_extensions: + - admonition + - attr_list + - codehilite: + linenums: true + - meta + - pymdownx.caret + - pymdownx.critic + - pymdownx.details + - pymdownx.highlight: + anchor_linenums: true + - pymdownx.inlinehilite + - pymdownx.keys + - pymdownx.mark + - pymdownx.snippets + - pymdownx.superfences: + custom_fences: + - name: mermaid + class: mermaid + format: !!python/name:pymdownx.superfences.fence_code_format + - pymdownx.tabbed: + alternate_style: true + - pymdownx.tilde + - md_in_html + - tables + - toc: + permalink: "#" + baselevel: 1