Skip to main content

Docusaurus介绍

欢迎使用Docusaurus!这是一个由Facebook开发的开源项目,用于构建易于维护的开源项目文档网站。 本文将介绍如何使用Docusaurus创建文档。 简单说Docusaurus是一个静态网站生成器,它可以帮助你快速创建一个文档网站。默认可以创建两类内容:

  • 文档:用于展示项目的文档,可以包含多个版本。树形结构的目录,支持Markdown格式。适合记录项目的使用文档。
  • 博客:用于展示项目的博客,可以包含多个博客。流水帐式的文章,支持Markdown格式,适合记录项目的技术日常。

Docusaurus本身是采用React开发的,所以你可以在文档中使用React组件。同时,Docusaurus也支持自定义主题,可以根据自己的需求进行定制。 然而你可以只需要掌握基本的Markdown语法,就可以快速创建一个文档网站,并不需要了解React。

安装Docusaurus

如果从头安装Docusaurus,可以参考官方文档:安装Docusaurus。就不再赘述。

Markdown语法

Markdown是一种轻量级标记语言,可以快速编写文档。往往5分钟就可以学会Markdown的基本语法。可以参考Markdown语法。 如下是一个Markdown的基本语法:

标题:

# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

列表:

- 无序列表1
- 无序列表2
- 无序列表3
1. 有序列表1
2. 有序列表2
3. 有序列表3

链接:

[链接文字](链接地址)

图片:

![图片描述](图片地址)
tip

建议将图片保存到当前目录下,然后使用相对路径引用图片。

代码块开头,使用三个反引号,然后是代码块中的语言名称,代码块最后使用三个反引号结束。如:


```javascript
```python
```java

tip

代码块中的语言名称可以是JavaScript、Python、Java等,用于代码高亮显示。

表格:

| 表头1 | 表头2 | 表头3 |
| --- | --- | --- |
| 内容1 | 内容2 | 内容3 |

效果:

表头1表头2表头3
内容1内容2内容3

粗体和斜体:

--粗体--
__粗体__
*斜体*

编写文档的注意事项

  • 文档文件名必须是英文,不能包含中文。
  • 文档文件名中可以包含横杠-_.,不能包含空格。
  • 文档文件名中可以包含数字,但不能以数字开头。

Docusaurus的扩展

Docusaurus支持一些扩展,可以在文档中使用一些特殊的语法。常用的是添加注释、添加警告、添加提示等。如:

:::note
这是一个注释
:::
note

这是一个注释

:::tip
这是一个提示
:::
tip

这是一个提示

:::warning
这是一个警告
:::
warning

这是一个警告

:::danger
这是一个危险
:::
danger

这是一个危险

你有遗憾么?
遗憾,每个人不都有遗憾么? 没有人不遗憾,只有人不喊疼,我本以为人生最大的遗憾是所爱隔山海,山海不可平,后来才知道海有舟可渡,山有路可行,山海皆可平,难平是人心。