mkdocs.yml

site_name: 嘟嘟可收件箱使用指南
site_description: HUST 211 的软工项目文档
site_url: https://hust-example.com/
repo_url: https://gitee.com/anotheronezjy/hust-se-2022-autumn
copyright: Copyright © 2022 WriteBug HUST-211
docs_dir: "Docs"
nav: # 文档结构
  - 主页: index.md
  - 指南:
      - 开发:
          - DEV: developer/dev-pro.md
          - WEB: developer/web.md
          - FLASK: developer/flask.md
          - DB: developer/database.md
      - 用户:
          - 收集者: user-guide/collector.md
          - 提交者: user-guide/submitter.md
          - FAQ: user-guide/FAQ.md
  - 关于:
      - 我们: about/about-us.md
      - 版本: about/release-notes.md
theme:
  name: material
  language: "zh"
  palette: # 白天/夜间模式切换
    - scheme: default
      primary: cyan
      accent: cyan
      toggle:
        # icon: material/toggle-switch-off-outline
        icon: material/weather-night
        # name: Switch to dark mode
        name: 暗色模式
    - scheme: slate
      primary: deep purple
      accent: deep purple
      toggle:
        # icon: material/toggle-switch
        icon: material/weather-sunny
        # name: Switch to light mode
        name: 亮色模式
  features: # 标题行在页面下滑后自动隐藏
    - header.autohide
  # icon:
  #   admonition:
  #     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
plugins:
  - search
  - glightbox
  - mkdocstrings:
      handlers:
        python:
          paths: [Src/Flask]
markdown_extensions:
  - admonition
  - attr_list
  - codehilite:
      guess_lang: true
      use_pygments: true
  - md_in_html
  - toc:
      permalink: "#"
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.details
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  # Formatting 标记
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde