mkdocs.yml

---
# This file is used to split config and docs navigation
INHERIT: navigation.yml

# Project information
site_name: 豐收二號檔案站
site_url: https://aidocs.isuanova.com/
site_author: Suanova
site_description: >-
  Suanova AI documentation website.

# copyright
copyright: Copyright © 2016 - 2024 Suanova

# Repository
repo_name: sophongo/sophongo-docs

repo_url: https://github.com/sophongo/sophdoc
edit_uri: edit/main/docs/

use_directory_urls: false # disable https://www.mkdocs.org/user-guide/configuration/#use_directory_urls
strict: false # enable strict mode, https://www.mkdocs.org/user-guide/configuration/#strict

# Configuration
theme:
  name: material
  language: en

  features:
    - content.code.annotate
    - content.code.copy
    - content.tooltips
    - content.action.edit
    - content.action.view
    - navigation.indexes
    - navigation.tabs
    - navigation.instant
    - navigation.prune
    - navigation.sections
    - navigation.tabs.sticky
    - navigation.tracking
    - navigation.top
    - search.highlight
    - search.suggest
    - search.share
    - toc.follow
    - navigation.path
    - navigation.footer
    # - toc.integrate

  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  font:
    text: Roboto
    code: Roboto Mono
  favicon: images/favicon.ico
  logo: images/suanova.png
  icon:
    logo: logo
    repo: fontawesome/brands/github

# Plugins
plugins:
  search:
    lang:
      zh
      en
  
  swagger-ui-tag: # enable swagger-ui-tag plugin

  git-revision-date-localized:
    enable_creation_date: false

  git-committers:
    repository: sophongo/sophdoc
    branch: main
    enable: true
    token: !ENV ["MKDOCS_GIT_COMMITTERS_APIKEY"]
  
  redirects:
    redirect_maps:
      dce/what/index.md: index.md
      ghippo/user-guide/audit/gproduct-audit/amamba/index.md: admin/ghippo/audit/gproduct-audit/kpanda.md
      ghippo/user-guide/personal-center/ssh-key/index.md: end-user/ghippo/personal-center/ssh-key.md
      ghippo/user-guide/audit/open-audit/index.md: admin/ghippo/audit/open-audit.md
      ghippo/permissions/kpanda.md: admin/ghippo/permissions/kpanda.md
      kpanda/user-guide/scale/hpa-cronhpa-compatibility-rules.md: admin/kpanda/scale/hpa-cronhpa-compatibility-rules.md
      kpanda/user-guide/namespaces/exclusive/index.md: admin/kpanda/namespaces/exclusive.md
      insight/user-guide/quickstart/otel/operator/index.md: admin/insight/quickstart/otel/operator.md
      insight/user-guide/quickstart/jvm-monitor/otel-java-agent/index.md: admin/insight/quickstart/otel/java/jvm-monitor/otel-java-agent.md
      insight/user-guide/quickstart/jvm-monitor/legacy-jvm/index.md: admin/insight/quickstart/otel/java/jvm-monitor/legacy-jvm.md
      insight/user-guide/quickstart/otel/golang/index.md: admin/insight/quickstart/otel/golang/golang.md
      en/dce/what/index.md: en/index.md
      en/ghippo/user-guide/audit/gproduct-audit/amamba/index.md: en/admin/ghippo/audit/gproduct-audit/kpanda.md
      en/ghippo/user-guide/personal-center/ssh-key/index.md: en/end-user/ghippo/personal-center/ssh-key.md
      en/ghippo/user-guide/audit/open-audit/index.md: en/admin/ghippo/audit/open-audit.md
      en/ghippo/permissions/kpanda.md: en/admin/ghippo/permissions/kpanda.md
      en/kpanda/user-guide/scale/hpa-cronhpa-compatibility-rules.md: en/admin/kpanda/scale/hpa-cronhpa-compatibility-rules.md
      en/kpanda/user-guide/namespaces/exclusive/index.md: en/admin/kpanda/namespaces/exclusive.md
      en/insight/user-guide/quickstart/otel/operator/index.md: en/admin/insight/quickstart/otel/operator.md
      en/insight/user-guide/quickstart/jvm-monitor/otel-java-agent/index.md: en/admin/insight/quickstart/otel/java/jvm-monitor/otel-java-agent.md
      en/insight/user-guide/quickstart/jvm-monitor/legacy-jvm/index.md: en/admin/insight/quickstart/otel/java/jvm-monitor/legacy-jvm.md
      en/insight/user-guide/quickstart/otel/golang/index.md: en/admin/insight/quickstart/otel/golang/golang.md

# Customization Javascript
extra_javascript:
  - stylesheets/zoom_image.js
  # - https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js # disable fix mermaid not working

# Customization css
extra_css:
  - stylesheets/custom.css

extra:
  analytics: 
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/emoticon-happy-outline
          name: This page was helpful
          data: 1
          note: >-
            Thanks for your feedback!
        - icon: material/emoticon-sad-outline
          name: This page could be improved
          data: 0
          note: >- 
            Thanks for your feedback! You can provide some comments if possible.

# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - meta
  - md_in_html
  - tables
  - toc:
      permalink: true
      title: 导航
      toc_depth: 3
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      # emoji_index: !!python/name:materialx.emoji.twemoji
      # emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: Sophongo
      repo: Sophongo-docs
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - pymdownx.critic
  - pymdownx.snippets
  #     auto_append:
  #       - includes/glossary.md