Markdown Title

Docusaurus是由facebook开源的文档系统，让开发者可以专注文档内容本身，而不需要从0构建一个文档知识库系统。在使用过程中，可以随时通过官方文档获取更多帮助.

Markdown语法

基本语法

Markdown是一种纯文本格式的标记语言。通过简单的标记语法，它可以使普通文本内容具有一定的格式。markdown语法

温馨提示：在Docusaurus中，第一个一级标题将被视为当前文档的标题，二级和三级标题则会生成右侧的目录树。建议在文档中仅使用一个一级标题，且作为文档标题使用。

行内代码

int a=b;可以在文本的行内显示代码。

代码块

res://main/main.cpp
int main(){
  return 0;
}

插入视频

可以使用以下html语法在文档中嵌入视频，只需将src的内容修改为视频的地址即可。注意本站资源使用相对地址，cdn或obs对象存储使用绝对地址。

<video width="100%" controls>
  <source src="../../../video/snow.mp4" type="video/mp4"/>
</video>

插入表格

参数	描述
`url`	站点Url. 如果网站部署在 `https://my-org.com/my-project/`, `url` 就是 `https://my-org.com/`.
`baseUrl`	站点的 base URL，带有末尾斜杠。如果网站部署在 `https://my-org.com/my-project/`, `baseUrl` 就是 `/my-project/`.

进阶使用

资源路径

大家在写文档的时候，或多或少都会遇到插入视频、图片等资源素材的问题，如何在书写markdown时，指定资源的路径也会给大家造成一些困惑，下面我们就一起来看看吧。

相对当前md文件的资源路径

![](./4_plugins/4-1_nature/img/Ocean/sceneTree.png) 或![](4_plugins/4-1_nature/img/Ocean/sceneTree.png) 是intro.md同级目录下4_plugins下的一张图片。如果路径最开始的.不加的话，将会去找根目录下的资源。

相对于web app根目录的资源路径

本项目中static文件夹下的内容在build的时候，会被直接放在服务器的根目录，我们可以通过以下的路径访问：/img/3-2-4_shader/shader_effect.jpg

Markdown文档间跳转

我们可以使用类似超链接的方式增加文档间的跳转功能，如我们想要跳转到编辑器的介绍页面。

[U跳转到编辑器的功能介绍页面](./tutorial/2_editor/index.md)

页面跳转示例：跳转到编辑器的功能介绍页面

附注标记

为了便于用户学习，我们可以通过附注的方式为读者提醒或者做进一步的说明。下面将为大家逐一展示下Docusaurus支持的附注效果。

:::note

Some **content** with _markdown_ `syntax`. Check [this `api`](#).

:::