mkdocs.yml

site_name: 'KubeOperator 文档'
site_url: 'https://kubeoperator.io'
site_author: 'wanghe'
site_description: 'KubeOperator 是一个开源的轻量级 Kubernetes 发行版'

repo_name: 'KubeOperator/KubeOperator'
repo_url: 'https://github.com/KubeOperator/KubeOperator'
edit_uri: ''

theme:
  name: 'material'
  logo: 'img/kubeoperator-white.png'
  favicon: 'img/KubeOperator-icon.png'
  language: 'zh'
  palette:
    - scheme: default
      accent: 'red'
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - scheme: slate
      accent: 'red'
      toggle:
        icon: material/weather-night
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.indexes
    - navigation.top
    - search.suggest
    - search.highlight
    - search.share
    - header.autohide
  font: false
  custom_dir: 'theme'
  icon:
    repo: fontawesome/brands/github

nav:
  - 总体介绍: index.md
  - 主要概念: concept.md
  - 系统架构: system_arch.md
  - 安装部署: installation/install.md
  - 快速入门:
    - 系统设置: quick_start/system_settings.md
    - 集群规划:
      - 手动模式: quick_start/cluster_planning/manual.md
      - 自动模式: quick_start/cluster_planning/automatic.md
    - 集群部署: quick_start/cluster_deployment.md
    - 集群导入: quick_start/cluster_import.md
  - 使用指南:
    - 集群: user_manual/cluster.md
    - 主机: user_manual/hosts.md
    - 自动模式: user_manual/plan.md
    - 备份账号: user_manual/backup_account.md
    - 版本管理: user_manual/version.md
    - 项目管理: user_manual/project.md
    - 用户管理: user_manual/user_management.md
    - 系统日志: user_manual/system_log.md
    - 系统设置: user_manual/system_management.md
  - 开发文档:
    - 开发环境搭建: dev/dev_manual.md
    - API 文档: dev/rest_api.md
  - 更新日志: about/changelog.md

markdown_extensions:
  - admonition
  - abbr
  - attr_list
  - def_list
  - footnotes
  - meta
  - toc:
      permalink: ⚓︎
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
      options:
        custom_icons:
          - theme/.icons
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.saneheaders
  - pymdownx.magiclink:
      repo_url_shortener: true
      repo_url_shorthand: true
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

extra:
  kubeoperator:
    version: v3.16.4
  search:
    separator: '[\s\-\.]+'
    language: 'zh'
    Content-Encoding: gzip
  generator: false
  version:
    default: master
    provider: mike
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/KubeOperator
    - icon: fontawesome/solid/envelope
      link: mailto:support@fit2cloud.com
    - icon: fontawesome/brands/skype
      link: tel://400-052-0755

extra_css:
    - css/extra.css

copyright: Copyright &copy; 2014-2024 <a href="https://www.fit2cloud.com">杭州飞致云信息科技有限公司</a>, All Rights Reserved. <a href="http://www.beian.miit.gov.cn" target="_blank">京ICP备15023818号</a>
plugins:
    - search
    - macros