Repository navigation
Expand file tree
/
Copy pathmkdocs.yml
More file actions
131 lines (106 loc) · 4.64 KB
/
Copy pathmkdocs.yml
File metadata and controls
131 lines (106 loc) · 4.64 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
site_name: 社区介绍
site_url: https://openhutb.github.io/.github/
# 参考链接:https://blog.csdn.net/m0_63203517/article/details/129765689
#repo_url: https://github.com/carla-simulator/carla
#docs_dir: Docs
#edit_uri: 'edit/master/Docs/'
# 设置编译页面的链接的前缀
repo_url: https://github.com/OpenHUTB/.github
# 页面右上角添加直接编辑页面的按钮
edit_uri: edit/master/docs/
theme:
name: readthedocs
sticky_navigation: True
navigation_depth: 3
features:
- search.suggest # 在目录栏中的搜索框中输入一些字母时推荐补全整个单词
# extra_css: [extra.css]
# 说明:docs/extra.css 从未存在,构建产物里也不会有该文件,
# 保留这行会让每个页面都产生一次 404(线上站点已实测确认)。
# 如果确实需要自定义样式,请补上 docs/extra.css 后再取消注释。
# mathjax用于单独公式展示
extra_javascript:
# - extra.js
- https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.4/MathJax.js?config=TeX-AMS-MML_HTMLorMML
- https://cdnjs.cloudflare.com/ajax/libs/mermaid/10.9.1/mermaid.min.js
- https://cdnjs.cloudflare.com/ajax/libs/raphael/2.2.7/raphael.min.js
- https://cdnjs.cloudflare.com/ajax/libs/underscore.js/1.8.3/underscore-min.js
- https://cdnjs.cloudflare.com/ajax/libs/js-sequence-diagrams/1.0.6/sequence-diagram-min.js
- https://cdnjs.cloudflare.com/ajax/libs/flowchart/1.6.5/flowchart.min.js
# js/umlconvert.js 从未存在,构建产物里也不会有该文件,
# 保留这行会让每个页面都产生一次 404(线上站点已实测确认)。
# 该脚本用于渲染 ```flow / ```sequence 围栏代码块,目前仓库里
# 没有任何页面使用这两种代码块,所以直接移除引用。
# - js/umlconvert.js
plugins:
- search:
lang: zh
separator: '[\s\-\.]+'
min_search_length: 2
- bibtex:
bib_file: refs.bib
csl_file: nature.csl
- mkdocs-video:
is_video: True
video_autoplay: True
video_loop: True
- mermaid2
extra:
generator: false
hooks:
- hooks.py
copyright: OpenHUTB 版权所有 © {year}
nav:
- 首页: 'index.md'
- 模拟器简介: 'simulator.md'
- 贡献指南: 'CONTRIBUTING.md'
- Git 教程: 'https://openhutb.github.io/git/?locale=zh_CN'
- Markdown教程: 'https://docs.github.com/zh/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax'
- 论文写作技巧: 'paper_tips.md'
- 搭建自定义开发环境: 'env_conf.md'
- 远程办公: 'rustdesk_tailscale.md'
- 提问技巧: 'ask_question.md'
- 科学上网: 'https://openhutb.github.io/doc/build_carla/#internet'
# 以下为补充收录的文档页面
- 贡献相关:
- 社区行为准则: 'community/code-of-conduct.md'
- 基于浏览器的贡献指南: 'codespace.md'
- 注册 Github 账号: 'dev/sign_up.md'
- 使用 VScode 推送代码: 'dev/vscode_push.md'
- PyCharm 教程: 'pycharm-tutorial.md'
- 使用 TortoiseGit 解决冲突: 'resolve_conflict.md'
- 合并提交: 'dev/merge_commit.md'
- 给 Ubuntu 虚拟机硬盘扩容: 'dev/vm_disk.md'
- 注意事项: 'note.md'
- wsl 安装与配置和卸载: 'wsl.md'
- 文档修改指南: 'submit.md'
- 视频制作流程: 'video_editing.md'
- 查找文档作者与源码: 'adv/find_author.md'
- 工具与资源:
- 开源工具列表: 'tools.md'
- 三维建模软件 Blender 介绍: 'blender.md'
- Markdown 一键发布到社交平台: 'markdown2anything.md'
- Java 版 Minecraft 回退旧版本指南: 'Minecraft Java Edition Downgrade Guide.md'
- Python 论文绘图脚本: 'src/python/README.md'
- 学习与论文:
- "Latex文献引用编译办法": 'bib_reference_guide.md'
- 本科毕业设计: 'undergraduate.md'
- 论文成果:AVF-BEL 视听融合: 'paper/avf.md'
- 社区组织形式: 'org/architecture.md'
# - mdx_math 用于行内公式显示
markdown_extensions:
- footnotes
- admonition
- mdx_math
# MkDocs 默认的 slugify 会先把标题做 NFKD 归一化、再丢弃所有非 ASCII 字符,
# 中文标题因此被清洗成空字符串,锚点退化成 _1、_2 这类无意义的占位符,
# 导致全站中文标题的页内跳转(各页面顶部的「目录」)全部失效。
# 改用 pymdown-extensions 自带的 Unicode 友好实现,保留中文锚点。
# 依赖 pymdown-extensions 已在 requirements.txt 中,无需新增。
- toc:
slugify: !!python/object/apply:pymdownx.slugs.slugify {kwds: {case: lower}}
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:mermaid2.fence_mermaid