文档主页 。
在Windows 10 和Windows 11上进行了测试。
- 安装python 3.11.11（或3.11.7），使用
pip安装mkdocs
pip install mkdocs -i http://mirrors.aliyun.com/pypi/simple --trusted-host mirrors.aliyun.com
pip install pymdown-extensions # pymdownx
pip install -r requirements.txt（可选）安装完成后使用mkdocs --version查看是否安装成功。
- 在命令行中进入
carla_doc目录下，运行：
mkdocs build
mkdocs serve然后使用浏览器打开 http://127.0.0.1:8000，查看文档页面能否正常显示。
- 部署到
github：
mkdocs gh-deploy该命令会自动将相应内容推送到项目的gh-pages分支上，然后在 Github 项目设置中选择好对应 GitPage 的分支，目录选择/(root)（注意不要是/(docs)，然后通过 https://openhutb.github.io/carla_doc/ 访问即可。
使用虚拟环境会出现找不到git的错误，请添加git的环境变量：
set path=%path%;C:\Program Files\Git\cmd\- 删除页脚（可选）
- 克隆删除页脚的mkdocs仓库（删除
mkdocs/themes/readthedocs /footer.html文件中的页脚内容）：
git clone https://github.com/OpenHUTB/mkdocs.git安装mkdocs包：
cd mkdocs
python -m pip install . -i http://mirrors.aliyun.com/pypi/simple --trusted-host mirrors.aliyun.com然后使用新的mkdocs执行步骤1-3。
将源代码、文档、软件等进行发布，具体步骤参考 链接 。
adv_*.md (advise_*.md) : 建议
build_*.md : 源代码构建
tuto_A_*.md (tutorial_asset_*) : 资产教程
tuto_D_*.md (tutorial_development_*) : 开发教程
tuto_E_*.md (tutorial_example_*) : 参考示例
tuto_G_*.md (tutorial_guide_*) : 指南教程
tuto_M_*.md (tutorial_map_*) : 地图教程
- 页面跳转
- 定义一个锚(id)：
<span id="jump"></span>或<span id="jump">跳转到的地方</span> - 使用markdown语法：
[点击跳转](#jump)
灰色底的变量名 variable：
**<font color="#f8805a">variable</font>**函数名 method ：
**<font color="#7fb800">method</font>**函数参数名 self：
<font color="#00a6ed">**self**</font>注意：markdown_extensions:标签内需要加上- mdx_math（python环境需要安装依赖python-markdown-math）。
行内公式
\(...\)
行间公式
$$
a + b = c
$$
常见图的绘制请参考绘图指南 。
ERROR - Config value: ‘plugins‘. Error: The “redirects“ plugin is not installed
解决 ：
pip install redirects编译出错解决：
Config value: 'markdown_extensions'. Error: Failed loading extension "mdx_gh_links".
手动安装库 ：
pip install mdx_gh_links克隆仓库时报错：
fatal: early EOF
fatal: fetch-pack: invalid index-pack output
解决：
# 设置下载缓存参数
git config --global http.postBuffer 2G
# 确认参数是否正确设置
git config http.postBuffer