documents/mkdocs.yml at master · inhandnet/documents · 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
site_name: 映翰通在线文档
site_description: 映翰通产品文档中心
site_url: https://inhand.com.cn/docs/
# 本地预览保持为空，避免资源被错误前缀；发布时改成你的 GitHub Pages 地址
# site_url: ""

repo_url: https://github.com/inhandnet/documents
repo_name: inhandnet/documents
edit_uri: edit/main/docs/zh/

# 方案 B：中文/英文各自独立 docs_dir，构建两次输出到 / 与 /en
docs_dir: docs/zh

# 输出为 *.html（避免依赖目录 /index.html 的自动补全）
use_directory_urls: false

# 自动导航时隐藏图片目录（避免 img/ 和 images/ 出现在侧边栏）
not_in_nav: |
  **/images/**
  **/img/**

theme:
  name: material
  language: zh
  custom_dir: overrides
  logo: assets/logo.png
  favicon: assets/logo.png
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.top
    - navigation.indexes
    - content.code.copy
#    - content.action.edit  # 隐藏编辑按钮（客户视图）
    - search.suggest
    - search.highlight
    - toc.follow
  palette:
    - scheme: default
      primary: green
      accent: green
    - scheme: slate
      primary: green
      accent: green

markdown_extensions:
  - admonition
  - tables
  - attr_list
  - md_in_html
  - toc:
      permalink: true
      toc_depth: 4
      title: 目录
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - pymdownx.highlight:
      linenums: true
      anchor_linenums: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.mark

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/pdf.js
  - javascripts/embed-bridge.js
  - javascripts/sidebar-search.js
  - javascripts/edit-under-title.js
  - javascripts/toc-h1.js

plugins:
  - search