个人网站搭建指南

本网站基于 mkdocs-material 开发，因此最佳方案为在本地安装 mkdocs-material 及插件：

pip install mkdocs-material mkdocs-git-revision-date-localized-plugin mkdocs-glightbox mkdocs-awesome-pages-plugin mkdocs-i18n

由于可能存在的安装包冲突等未知问题，推荐使用一个全新的 conda 或 pip 环境

然后在根目录下运行

mkdocs serve

即可在 localhost:8000 预览网页效果。更多相关信息，请访问官方Wiki.

---

一些经验

这种搭建网站的方式仅支持以 markdown 格式作为网页内容，实际上相当于个人博客。

---

推荐把网站搭载在 github 提供的免费网站服务器上，并且按照教程配置 gh-pages 分支的自动化追踪更新行为。

---

超链接相关

可以如下进行超链接编辑

[显示的的文字内容](跳转的地址){其它设置}

例如：[git 相关操作](./git 用法.md#3-ssh){target="_blank"}

这里的 {target="_blank"} 代表新开一个页面；#3-ssh 是特定章节的代号，有公式，但是不用记，直接在浏览器上打开这个要跳转的内部地址，点到这个章节，看网址就行。比如，以上例子的网址是 https://cloudmosquito.github.io/工具/git 用法/#3-ssh 。

效果如下：git 相关操作 。

数学公式相关

文档中的行间公式支持以下两种语法：

$$ JiaZhuang = Zhe * (Shi - Yi_Ge) + Shi^{Zi} $$

\[ JiaZhuang = Zhe * (Shi - Yi_Ge) + Shi^{Zi} \]

效果如下：

\[ JiaZhuang = Zhe * (Shi - Yi_Ge) + Shi^{Zi} \]

\[ JiaZhuang = Zhe * (Shi - Yi_Ge) + Shi^{Zi} \]

Warning

公式前后必须各空一行，否则无法正常渲染。

---

图片相关

如需在文档内添加图片等资源，在文档根目录下创建 <文件名>.assets/ 目录来存放。

并且在 markdown里如下调用：

![](./ROS2%20学习记录.assets/rcl_layer.png){width=50%}

效果如下：

美观起见，一般需要让图片居中。可以在 docs/stylesheets/extra.css 里添加

   .img-center {
     display: block;
     margin-left: auto;
     margin-right: auto;
   }

Note

需要先保证 mkdocs.yml 配置文件中添加了 extra.css 文件：

extra_css:
    - stylesheets/extra.css

然后修改 Markdown ：

![](./ROS2%20学习记录.assets/rcl_layer.png){.img-center width=50%}

效果如下：