mkdocs.yml

# 工程师知识库 - MkDocs 配置
site_name: 工程师知识库
site_description: 个人工程知识管理系统，覆盖嵌入式、AI、云计算等全栈技术领域
site_author: Engineer
site_url: https://knowledge.example.com

# 仓库配置
repo_name: knowledge-system
repo_url: http://localhost:3001/admin/knowledge-system
edit_uri: _edit/main/knowledge/

# 排除不需要构建的目录
exclude_docs: |
  _site/
  _wiki/
  __pycache__/
  *.py
  *.pyc

# 主题配置
theme:
  name: material
  language: zh
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: 切换到深色模式
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: 切换到浅色模式

  features:
    - navigation.instant        # 即时加载
    - navigation.tracking       # 锚点跟踪
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand         # 默认展开
    - navigation.top            # 返回顶部按钮
    - navigation.indexes        # 分组首页支持
    - navigation.path           # 面包屑导航
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate
    - content.tooltips          # 工具提示
    - content.action.edit       # 编辑此页按钮
    - content.action.view       # 查看源代码按钮
    - toc.follow

  icon:
    repo: fontawesome/brands/git-alt
    logo: material/book-open-page-variant

  font:
    text: Noto Sans SC
    code: Roboto Mono

# 插件
plugins:
  - search:
      lang:
        - zh
        - en
      separator: '[\s\u200b\-\.\u4e00-\u9fff]+'
      pipeline:
        - stemmer
        - stopWordFilter
        - trimmer
  - awesome-pages:
      filename: .pages
      collapse_single_pages: false
      strict: false
  # - git-revision-date-localized:
  #     enable_creation_date: true
  #     type: datetime
  #     enable_git_follow: false
  # - minify:
  #     minify_html: true
  #     minify_js: true
  #     minify_css: true
  #     htmlmin_opts:
  #       remove_comments: true

# Markdown 扩展
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
      permalink_title: 锚点链接
      toc_depth: 3

  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - 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.snippets

# 额外配置
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com
      name: GitHub
  copyright: Copyright © 2025 Engineer Knowledge System

# 额外 CSS
extra_css:
  - stylesheets/extra.css

# 额外 JavaScript
extra_javascript:
  - https://unpkg.com/mermaid@10/dist/mermaid.min.js
  - javascripts/mermaid-init.js
  - javascripts/mathjax.js
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

# 文档目录
docs_dir: knowledge

# 导航由 awesome-pages 插件根据各目录的 .pages 文件自动生成（不需要手写 nav）