doc/mkdocs.yml at master · OpenHUTB/doc · 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
site_name: 人车孪创
# 参考链接：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/doc

# 页面右上角添加直接编辑页面的按钮
edit_uri: edit/master/docs/

theme:
  name: readthedocs
  sticky_navigation: True
  navigation_depth: 3
  features:
    - search.suggest # 在目录栏中的搜索框中输入一些字母时推荐补全整个单词
extra_css: [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://cdn.rawgit.com/knsv/mermaid/6.0.0/dist/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

plugins:
  - search:
      lang: ja
      separator: '[\s\-\.]+'
      min_search_length: 1

extra:
  generator: false

copyright: OpenHUTB 版权所有 &copy; 2026

nav:
- 简介:
  - 入门: 'introduction.md'
  - 人: 'pedestrian.md'
  - 车: 'vehicle.md'
- 模拟:
  - 概念: 'concept.md'
  - 模块: 'modules.md'
  - 开发: 'development.md'
- 场景:
  - 地图孪生: 'map_twin.md'
  - 资产孪生: 'assert_twin.md'
  - 模拟引擎: 'unreal_engine.md'
- 其他:
  - 参考目录: 'ref.md'
  - 生态系统: 'ecology.md'
  - 贡献指南: 'contribution.md'

# - mdx_math 用于行内公式显示
markdown_extensions:
  - pymdownx.blocks.html
  - admonition
  - mdx_math
  - pymdownx.superfences:
      custom_fences: [
         { name: flow, class: uml-flowchart }
        ,{ name: sequence, class: uml-sequence-diagram }
        ,{ name: mermaid, class: mermaid }
      ]