Repository navigation
Expand file tree
/
Copy pathmkdocs.yml
More file actions
213 lines (207 loc) · 8.32 KB
/
Copy pathmkdocs.yml
File metadata and controls
213 lines (207 loc) · 8.32 KB
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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
site_name: QIm
site_url: https://czyt1988.github.io/QIm/
site_author: 'Chen ZongYan'
site_description: 'Qt 4 ImGui'
repo_url: https://github.com/czyt1988/QIm
repo_name: QIm-github
# 排除 Doxygen 生成的 API 文档目录(由 workflow 手动复制到 site/)
exclude_docs: |
doxygen/
doxygen-en/
# 多语言站点信息
extra:
site_name:
zh: QIm
en: QIm
alternate:
- name: English
link: /QIm/
lang: en
- name: 中文
link: /QIm/zh/
lang: zh
# 主题
theme:
name: material
language: en
palette:
- scheme: default
toggle:
icon: material/brightness-4
name: Switch to dark
- scheme: slate
toggle:
icon: material/brightness-7
name: Switch to light
features:
- navigation.tabs # 顶部栏分类导航
- navigation.sections # 侧边栏章节可折叠
- navigation.top # 右下角"回到顶部"按钮
- navigation.path # 顶部面包屑导航条
- navigation.expand # 默认展开全部章节,一眼看到整本书
- navigation.indexes # 允许章节首页可点击
- navigation.footer # 底部导航条
- content.code.copy # 代码块右上角出现"复制"按钮
- content.code.annotate # 代码块行内注释气泡
- search.suggest # 搜索框实时联想补全
- search.highlight # 点击结果后正文高亮匹配关键词
- search.share # 支持复制带关键词的搜索链接
- toc.follow # 滚动时自动跟随当前章节
# 插件配置
plugins:
- search
- i18n:
docs_structure: folder
languages:
- locale: en
name: English
default: true
build: true
nav:
- Home: index.md
- Core Concepts:
- Render Node: render-node.md
- Object Tree: object-tree.md
- PIMPL Pattern: pimpl-pattern.md
- Signal/Slot: signal-slot.md
- Property System: property-system.md
- Color Mapping: colormap.md
- 2D Plot:
- Overview: plot2d/index.md
- Figure Widget: plot2d/figure-widget.md
- Plot Container: plot2d/plot-node.md
- Axis Configuration: plot2d/plot-axis.md
- Basic Charts: plot2d/plot-basic-charts.md
- Line Plot: plot2d/plot-line.md
- Bar Charts: plot2d/plot-bar-charts.md
- Area Charts: plot2d/plot-area-charts.md
- Special Charts: plot2d/plot-special-charts.md
- Annotations: plot2d/plot-annotations.md
- Interactive Tools: plot2d/plot-tools.md
- Value Tracker: plot2d/value-tracker.md
- Data Series: plot2d/data-series.md
- Downsampling: plot2d/downsampling.md
- 3D Plot:
- Overview: plot3d/index.md
- Basic Charts: plot3d/basic-charts.md
- Surface Charts: plot3d/surface-charts.md
- Mesh Charts: plot3d/mesh.md
- Annotations: plot3d/annotations.md
- Configuration: plot3d/configuration.md
- Development Standards:
- Overview: dev/index.md
- Qt Integration Standards: dev/qt-integration.md
- Coding & Comment Standards: dev/coding-standards.md
- PIMPL Development Guide: dev/pimpl-dev-guide.md
- Render Performance Guidelines: dev/render-guidelines.md
- Flag Mapping Standards: dev/flag-mapping.md
- New Node Development Guide: dev/new-node-guide.md
- Custom Node: dev/custom-node.md
- Lifecycle Pitfalls: dev/lifecycle-pitfalls.md
- Usage Guide:
- Render Mode: render-mode.md
- API Reference:
- C++ API Docs: api-reference.md
- Others:
- Performance: performance.md
- Font: font.md
- locale: zh
name: 中文
build: true
nav:
- 首页: index.md
- 核心概念:
- 渲染节点: render-node.md
- 对象树: object-tree.md
- PIMPL模式: pimpl-pattern.md
- 信号槽: signal-slot.md
- 属性系统: property-system.md
- 颜色映射: colormap.md
- 2D绘图:
- 概述: plot2d/index.md
- Figure Widget: plot2d/figure-widget.md
- 绘图容器: plot2d/plot-node.md
- 坐标轴配置: plot2d/plot-axis.md
- 基本图表: plot2d/plot-basic-charts.md
- 线条图: plot2d/plot-line.md
- 柱状图类: plot2d/plot-bar-charts.md
- 填充区域: plot2d/plot-area-charts.md
- 特殊图表: plot2d/plot-special-charts.md
- 标注类: plot2d/plot-annotations.md
- 交互工具: plot2d/plot-tools.md
- 数值跟踪器: plot2d/value-tracker.md
- 数据系列: plot2d/data-series.md
- 降采样: plot2d/downsampling.md
- 3D绘图:
- 概述: plot3d/index.md
- 基本图表: plot3d/basic-charts.md
- 曲面图表: plot3d/surface-charts.md
- 网格: plot3d/mesh.md
- 标注: plot3d/annotations.md
- 配置: plot3d/configuration.md
- 开发规范:
- 概述: dev/index.md
- Qt集成规范: dev/qt-integration.md
- 代码风格与注释规范: dev/coding-standards.md
- PIMPL开发规范: dev/pimpl-dev-guide.md
- 渲染性能规范: dev/render-guidelines.md
- 枚举语义转换规范: dev/flag-mapping.md
- 新节点开发指南: dev/new-node-guide.md
- 自定义节点: dev/custom-node.md
- 初始化时序陷阱: dev/lifecycle-pitfalls.md
- 使用指南:
- 渲染模式: render-mode.md
- API参考:
- C++ API文档: api-reference.md
- 其它:
- 性能对比: performance.md
- 字体: font.md
# 需要版本切换再打开下面
# - git-revision-date
# - mike:
# version_selector: true
# 需要导出pdf再打开下面
# - with-pdf:
# # 启用整站 PDF 导出
# output_path: pdf/DAWorkBench.pdf
# cover: true
# cover_title: DAWorkBench 用户手册
# cover_subtitle: 基于工作流数据的分析工具
# cover_logo: assets/icon.png
# verbose: true
markdown_extensions:
# ===== 基础官方扩展 =====
- meta # 允许在页头写 YAML 元数据(title / description / tags …)
- abbr # 缩写注解:正文里写 *[HTML]: 超文本标记语言,鼠标悬停显示全称
- attr_list # 给图片、链接、段落等任意元素加 class/id,例如 {.shadow #pic}
- def_list # 定义列表,写术语/释义更方便(HTML 的 <dl><dt><dd>)
- footnotes # 脚注 [^1] 与文末 [^1]: 内容,自动编号、回链
- tables # GitHub 风格管道符表格 | 表头 | 表头 |
- md_in_html # 在原生 HTML 标签(如 <div>)里继续解析 Markdown
- toc: # 右侧/侧边目录;permalink: true 给每级标题加 ¶ 锚链
permalink: true
- fenced_code # 支持 ``` 围栏代码块(高亮、行号等玩法的前提)
- nl2br # 换行直接转 <br>,不用末尾再空两格
- admonition # 开启 !!! 语法
- pymdownx.highlight:
linenums: true
linenums_style: table
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- 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.caret
- pymdownx.keys
- pymdownx.mark
- pymdownx.tilde
- pymdownx.tasklist:
custom_checkbox: true
# 添加额外的 CSS 文件
extra_css:
- stylesheets/extra.css