mkdocs.yml

site_name: "DevOps-Boot: FastAPI-Traefik-K8s"
site_url: https://devops-boot.netlify.app/
repo_url: https://github.com/devops-boot/fastapi-k8s/
#repo_name: squidfunk/mkdocs-material
edit_uri: edit/main/docs/
site_description: "Project Documentation for FastAPI-Traefik-K8s Team during DevUniversity DevOps Bootcamp 202309"
site_author: Jacint Balint, Gaudry Joseph-Angélique, Wenceslas Le Texier, Jérémie Tarot
#copyright:
#remote_branch: ""
#remote_name: ""
#docs_dir:
# nav:
#   - Home: index.md
#   - Project:
#     - project/index.md
#     - Introduction: project/introduction.md
#     #- Requirements:
#     - Situations:
#       - project/situations/index.md
#       - project/situations/gja.md
#       - project/situations/jbt.md
#       - project/situations/jtt.md
#       - project/situations/wlt.md
#     - Conclusion: project/conclusion.md
#   - Documentation:
#     - documentation/index.md
#     - Project management: documentation/pm.md
#     - Source code management: documentation/scm.md
#     - Installation: documentation/installation.md
#     - Documentation: documentation/documentation.md
#   - Appendices: appendices/index.md
exclude_docs: |
  .placeholder
  .pages
#not_in_nav:
theme:
  name: material
  #custom_dir: overrides
  locale: en
  palette:
    # Palette toggle for dark mode
    - scheme: slate
      primary: teal
      accent: lime
      media: "(prefers-color-scheme: dark)"
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    # Palette toggle for light mode
    - scheme: default
      primary: teal
      accent: green
      media: "(prefers-color-scheme: light)"
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
  font:
    text: Comfortaa
    code: B612 Mono
  #logo: assets/images/logo.png
  icon:
    logo: material/cloud-circle
    # menu:
    # alternate:
    # search:
    # share:
    # close:
    # top:
    edit: material/pencil
    view: material/eye
    # repo: fontawesome/brands/git-alt
    admonition:
      # Octoicons set
      note: octicons/tag-16
      abstract: octicons/checklist-16
      info: octicons/info-16
      tip: octicons/squirrel-16
      success: octicons/check-16
      question: octicons/question-16
      warning: octicons/alert-16
      failure: octicons/x-circle-16
      danger: octicons/zap-16
      bug: octicons/bug-16
      example: octicons/beaker-16
      quote: octicons/quote-16
      # FontAwesome set
      # note: fontawesome/solid/note-sticky
      # abstract: fontawesome/solid/book
      # info: fontawesome/solid/circle-info
      # tip: fontawesome/solid/bullhorn
      # success: fontawesome/solid/check
      # question: fontawesome/solid/circle-question
      # warning: fontawesome/solid/triangle-exclamation
      # failure: fontawesome/solid/bomb
      # danger: fontawesome/solid/skull
      # bug: fontawesome/solid/robot
      # example: fontawesome/solid/flask
      # quote: fontawesome/solid/quote-left
    # https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/#tag-icons-and-identifiers
    # tag:
    # previous: fontawesome/solid/angle-left
    # next: fontawesome/solid/angle-right
  # favicon: assets/images/favicon.png
  features:
    #- header.autohide
    #- toc.integrate
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.path
    - navigation.top
    - navigation.footer
    - navigation.instant
    - navigation.instant.progress
    - navigation.tracking
    - toc.follow
    #- toc.integrate
    - search.suggest
    - search.share
    - content.action.view
    - content.action.edit
#site_dir: "site"
use_directory_urls: true
markdown_extensions:
  # Python Markdown
  # extra = abbr + attr_list + def_list + fenced code + footnotes + md_in_html + tables
  - extra
  - admonition
  # - codehilite # Superseded by highlight
  - meta
  - nl2br
  - sane_lists
  - smarty
  - toc:
      permalink: true
      baselevel: 1
      toc_depth: 3
  - wikilinks

  # Python Markdown Extensions
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      use_pygments: true
      pygments_lang_class: true
      auto_title: true
      anchor_linenums: true
      linenums_style: pymdownx-inline
      line_spans: __span
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.critic:
      mode: view
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      combine_header_slug: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - pymdownx.snippets:
      auto_append:
        - appendices/abbreviations.md
  - markdown_include.include:
      base_path: docs
  # - markdown_blockdiag:
  #     format: svg
plugins:
  - search:
      separator: '[\s\-\.\_]+'
  - awesome-pages:
      collapse_single_pages: true
  - section-index
  - tags:
      enabled: true
      tags_file: appendices/tags.md
  - git-revision-date-localized:
      enable_creation_date: true
      type: date
  # - ezglossary:
  #     use_default: true
  #     sections:
  #       - terms
  #       - config
  #     #inline_refs: full
  #     tooltip: full
  #     list_definitions: true
  #     list_references: true
  # https://github.com/AVATEAM-IT-SYSTEMHAUS/mkdocs-kroki-plugin
  - kroki:
      EnableDiagramsnet: true
      # DownloadImages: true
      # DownloadDir: assets/images/kroki_generated
      #HttpMethod: POST
      FileTypes:
        - svg
        - png
  # https://fotrimzi.github.io/mkdocs-showcase/variables.html
  - macros:
      include_yaml: ['docs/includes/extra.yaml']
  # https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/
  - social
  #     enabled: !ENV [CI, false]
  # # Document contributors (Sponsors only)
  # - git-committers:
  #     repository: squidfunk/mkdocs-material
  #     branch: main
  #     enabled: !ENV [CI, false]
  # # Document authors (lightweight alt. to git-commiters, Sponsors only)
  # - git-authors
  # - mkdocstrings:
  #     handlers:
  #       # See: https://mkdocstrings.github.io/python/usage/
  #       python:
  #         options:
  #           # Possible styles are sphinx, google, or numpy
  #           docstring_style: sphinx
  # - mike:
  #     # These fields are all optional; the defaults are as below...
  #     alias_type: symlink
  #     redirect_template: null
  #     deploy_prefix: ''
  #     canonical_version: null
  #     version_selector: true
  #     css_dir: assets/css
  #     javascript_dir: assets/js
# extra_css:
#   - assets/stylesheets/extra.css
# extra_javascript:
#   - assets/javascripts/extra.js
extra:
  # Set this if you want it to be different from site_url
  # homepage: https://example.com
  alternate:
    - name: English
      link: /en/
      lang: en
    - name: Français
      link: /fr/
      lang: fr
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/devops-boot/fastapi-k8s/
      name: Project repository on GitHub
    - icon: fontawesome/brands/slack
      link: https://dst-sept23.slack.com/app_redirect?channel=C061W1C8W3T
      name: Project Slack channel (private)
  #homepage: https://example.com
  version:
    provider: mike
copyright: Copyright © 2023 Jacint Balint, Gaudry Joseph-Angélique, Wenceslas Le Texier, Jérémie Tarot