mkdocs.yaml

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

# Project information
site_name: DaoCloud Enterprise OpenAPI
site_url: https://docs.daocloud.io/openapi/
site_author: DaoCloud
site_description: >-
  DaoCloud Enterprise 5.0 下一代容器化平台集大成者，引领云原生浪潮，推动数字化转型。

# copyright
copyright: Copyright © 2016 - 2023 DaoCloud

# Repository
repo_name: DaoCloud/DaoCloud-docs

repo_url: https://github.com/DaoCloud/DaoCloud-docs

# Configuration
theme:
  name: material

  language: "zh"
  features:
    - content.code.annotate
    - content.code.copy
    - content.tooltips
    # - 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
    # - 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/DaoCloud.png
  icon:
    logo: logo
    repo: fontawesome/brands/github

# Plugins
plugins:
  - search:
      separator: '[\\s\\u200b\\-]'
  - swagger-ui-tag

  - minify:
      minify_html: true
      minify_js: true
      minify_css: true
      htmlmin_opts:
        remove_comments: true

  - redirects:
      redirect_maps:
        "api.md": "dce/what.md"

  - git-revision-date: #每页底部显示文档最后更新日期，安装 pip install mkdocs-git-revision-date-plugin
      enabled_if_env: "CI"
  - git-revision-date-localized: #每个页面底部添加本地化更新和创建日期，安装 pip install mkdocs-git-revision-date-localized-plugin
      timezone: Asia/Shanghai
      type: timeago #日期格式，有效值为 date、datetime、iso_date、iso_datetimetimeago
      fallback_to_build_date: true #默认 false，启用则回退到 mkdocs build 执行的时间
      enable_creation_date: true #最后更新日期旁边显示与页面关联的文件的创建日期
      exclude:
        - index.md
      enabled: !ENV [ENABLED_GIT_REVISION_DATE, true]

# Customization
extra:
  homepage: /
  
  # comments
  comments:
    enabled: false
    mode: giscus
    type: Discussions

# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - meta
  - md_in_html
  - tables
  - toc:
      permalink: true
      title: 导航
      toc_depth: 5
  - 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:materialx.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: daocloud
      repo: daocloud-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