mkdocs.yml

site_name: CIS-C 在线文档
extra_css:
  - stylesheets/extra.css

theme:
  name: material
  custom_dir: overrides
  highlightjs: true
  language: zh
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.top
    - toc.follow
    - navigation.tracking
    - content.code.annotate
    - content.tooltips
    - search.highlight
    - search.share
    - search.suggest
    - announce.dismiss


# Extensions
markdown_extensions:
  - abbr
  - admonition
  - fenced_code
  - attr_list
  - def_list
  - footnotes
  - meta
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:materialx.emoji.to_svg
      emoji_index: !!python/name:materialx.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - 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

nav:
  - 主页: index.md
  - 版本发布:
    - 当前版本: Release-notes/index.md
    - v2.13: Release-notes/v2.13.md
    - v2.12: Release-notes/v2.12.md
    - v2.11: Release-notes/v2.11.md
    - v2.10: Release-notes/v2.10.md
    - v2.9: Release-notes/v2.9.md
  - 快速入门:
    - 准备工作: quick-start/index.md
    - 下载与安装: quick-start/installation.md
    - Prometheus集成: quick-start/prometheus.md
    - 卸载: quick-start/uninstall.md
  - 产品架构:
    - 整体架构: Architecture/index.md
    - 启动参数: Architecture/parameters.md
    - AS3参考: Architecture/as3.md  
  - 场景与配置:
    - HTTP业务发布: Use-Cases/http.md
    - HTTPS业务发布: Use-Cases/https.md
    - TCP(proxy)业务发布: Use-Cases/tcp.md
    - UDP(proxy)业务发布: Use-Cases/udp.md
    - FTP业务发布: Use-Cases/ftp.md
    - Hub模式发布: Use-Cases/hub.md
    - L4模式发布: Use-Cases/l4.md
    - IPV6发布: Use-Cases/ipv6.md
    - CIS与CIS-C混合部署: Use-Cases/cis-and-cis-c.md
    - 优雅下线业务Pod的方法: Use-Cases/k8s-graceful-shutdown.md
    - 多集群模式: Use-Cases/multi-clusters.md
  - 运维与排错: 
    - 常见问题: Operation-and-troubleshooting/ki.md
    - 迁移: Operation-and-troubleshooting/migration.md
  - 联系我们: 
    - 技术支持: Support-and-contact/index.md
    - 文档纠错: Support-and-contact/doc-revise.md

plugins:
  - search:
      separator: '[\s\u200b\-]'
  - git-revision-date-localized:
      type: datetime
      timezone: Asia/Shanghai
      enable_creation_date: true
      locale: en
      fallback_to_build_date: true
  - minify:
      minify_html: true
      htmlmin_opts:
        remove_comments: true

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/f5se/cis-c-docs/
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/r/f5devcentral/k8s-bigip-ctlr-c/tags


# Repository
repo_name: f5se/cis-c-docs
repo_url: https://github.com/f5se/cis-c-docs

# Copyright
copyright: Copyright © 2022 F5 CIS-C