mkdocs.yml

site_name: 三木奇奇怪怪的文档收录
site_url: https://docs.529300529.xyz
site_description: >-
  各种文档、记录整理收录合集

repo_name: Samuel-0-0/docs/
repo_url: https://github.com/Samuel-0-0/docs/

# 导航栏
nav:
    - Home: index.md
    - VAST系列产品手册:
      - vast/index.md
      - Stealthburner内嵌CAN控制板:
        - 概述: vast/sb-can/index.md
        - Canboot(可选): vast/sb-can/canboot.md
        - Klipper: vast/sb-can/klipper.md
      - 电源计量与远程控制:
        - 概述: vast/power/index.md
        - 固件: vast/power/firmware.md
        - Klipper: vast/power/klipper.md
      - Voron 0.2裙边按钮+屏幕套件:
        - 概述: vast/v0-skirt/index.md
        - Canboot(可选): vast/v0-skirt/canboot.md
        - Klipper: vast/v0-skirt/klipper.md
      - Voron 0.2集线板+主控板套件:
        - 概述: vast/D4/index.md
        - Canboot(可选): vast/D4/canboot.md
        - Klipper: vast/D4/klipper.md
      - 水冷套件(含控制板):
        - 概述: vast/water/index.md
        - 硬件安装: vast/water/manual.md
        - Canboot(可选): vast/water/canboot.md
        - Klipper: vast/water/klipper.md
    - SolidWorks:
      - solidworks/index.md
      - 设计相关: solidworks/solidworks.md
    - 3D打印机:
      - 3d_printer/index.md
      - 打印机安装调试:
        - Voron 0.2: 3d_printer/voron/v0.md
        - Voron 2.4: 3d_printer/voron/v2.md
      - Klipper安装及使用:
        - 加速度传感器应用: 3d_printer/klipper/shaper_tuning.md
        - 异常案例: 3d_printer/klipper/error.md
        - CAN相关: 3d_printer/klipper/canbus.md
        - 图形化一键脚本: 3d_printer/klipper/assistant.md
        - 7寸触屏小主机: 3d_printer/klipper/7inch.md
        - 其他: 3d_printer/klipper/klipper.md
      - 打印及切片软件调试: 3d_printer/slicer.md
      - 打印件及问题处理: 3d_printer/printing_issue.md
      - 3D打印机MODS:
        - Voron 0.2: 3d_printer/voron/v0_mods.md
        - Voron 2.4: 3d_printer/voron/v2_mods.md
        - 其他: 3d_printer/printers.md
    - CNC:
      - cnc/index.md
      - 机械速查表: cnc/holes_thread_shaft.md

plugins:
  - search

theme:
  name: material
  language: zh
  # 主题颜色
  palette:
    # 明亮模式
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: 切换到暗黑模式
    # 暗黑模式
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: 切换到明亮模式
  # 特征
  features:
    # 代码块复制按钮
    - content.code.copy
    # 代码块注解，使用方法：在代码要加注解的后面加"# (1)"
    # 然后在代码后面加"1.  注解的内容"
    - content.code.annotate
    # 顶部导航菜单
    - navigation.tabs
    # 展开菜单
    #- navigation.sections
    # 返回顶部按钮
    - navigation.top
    - search.highlight
    - search.share
    - search.suggest
  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

# markdowm扩展
markdown_extensions:
  # 警示栏
  - admonition
  # 警示栏可折叠
  - pymdownx.details
  - md_in_html
  # 代码显示样式
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  # 列表
  - def_list
  # 任务列表
  - pymdownx.tasklist:
      custom_checkbox: true

copyright: |
  &copy; 2023 <a href="https://github.com/Samuel-0-0"  target="_blank" rel="noopener">Samuel Wang (三木)</a>