ScriptsForMinecraftServer/mkdocs.yml at main · DogeLakeDev/ScriptsForMinecraftServer · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
site_name: ScriptsForMinecraftServer 文档
site_description: ScriptsForMinecraftServer 使用 · 开发 · 接口
site_url: https://dogelakedev.github.io/ScriptsForMinecraftServer/
repo_url: https://github.com/DogeLakeDev/ScriptsForMinecraftServer
repo_name: DogeLakeDev/ScriptsForMinecraftServer
edit_uri: edit/main/docs/
docs_dir: docs
site_dir: site

watch:
  - includes

theme:
  name: material
  language: zh
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: white
      toggle:
        icon: material/brightness-7
        name: 切换到深色模式
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      toggle:
        icon: material/brightness-4
        name: 切换到浅色模式
  features:
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.instant.preview
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.indexes
    - navigation.paths
    - navigation.top
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.tooltips
    - toc.follow
    - navigation.footer
  icon:
    repo: fontawesome/brands/github

plugins:
  - tags
  - search:
      lang:
        - zh
        - en
  - awesome-pages
  - exclude:
      glob:
        - plan/**
        - archive/**
        - reviews/**
  - git-revision-date-localized:
      # 本地关闭（省 ~14s）；CI 里 GitHub Actions 会设 CI=true
      enabled: !ENV [CI, false]
      fallback_to_build_date: true
      # TypeDoc 生成物不在 git 历史里，排除以免刷屏
      exclude:
        - reference/sdk/**

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - pymdownx.details
  - pymdownx.inlinehilite
  - toc:
      permalink: true
      toc_depth: 3
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - 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.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.snippets:
      # 路径相对 mkdocs 工作目录（仓根），不要加前导 /
      # 前导 / 会被当成文件系统绝对路径（Windows 上即 \includes\…），导致文件找不到、abbr 静默失效
      base_path:
        - .
      check_paths: true
      auto_append:
        - includes/abbreviations.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/DogeLakeDev/ScriptsForMinecraftServer

# 导航由 docs/.pages 与各子目录 .pages 控制（awesome-pages）
# 勿在此手写 nav，否则目录节无法展开

validation:
  omitted_files: warn
  # 文档会故意链到仓根源码 / workflow / configs（不在 docs_dir）。
  # 带扩展名 → links.not_found；无扩展名目录 → links.unrecognized_links
  not_found: ignore
  unrecognized_links: ignore
  anchors: warn

copyright: Copyright &copy; 2026 DogeLakeDev