跳到主要内容

Docusaurus 功能使用指南

· 阅读需 3 分钟
Yang Chu
Yang Chu
Product Manager @ Cyritex
Yakun Wu
Yakun Wu
VP @ Cyritex

列出了 Docusaurus 常用的功能

注意

完整的文档请参考 Docusaurus 功能使用指南

Meta 元信息​

Meta 元信息放在文档的最前面，其中：

  • slug 是用来生成文档的 URL，比如 http://192.168.2.217/blog/docs-format
  • title 是文档的标题，显示在浏览器标签上
---
slug: docs-format
title: 常用文档格式
---

代码​

  • 行内代码

单个反引号：内容前后各有一个反引号

  • 独立代码块
代码内容：

上方增加一行，顶格三个反引号 ``` + 代码语言

最后另起一行，顶格三个反引号 ```
  • 独立代码块加标题

在代码语言后面加上：1 个空格 + title="标题"

这是一个标题

bash title="这是一个标题"
  • 独立代码块高亮某行
bash 用 #
第一行不高亮
第二行高亮：在第三行上一行加 # highlight-next-line
第三行不高亮
第四行不高亮
第五行高亮：在第五行上一行加 # highlight-start
第六行高亮
第七行高亮：在第七行下一行加 # highlight-end
第八行不高亮
javascript 用 //
第一行不高亮
第二行高亮：在第三行上一行加 // highlight-next-line
第三行不高亮
第四行不高亮
第五行高亮：在第五行上一行加 // highlight-start
第六行高亮
第七行高亮：在第七行下一行加 // highlight-end
第八行不高亮

引用​

  • 引用超链接

欢迎访问塞讯科技公司官网

  • 引用图片
引用图片的前置工作

先将图片添加到 static/img目录下，并给予明确意义、可区分的命名，再在文档中引用。

img

提示高亮块​

信息

info 信息

提示

tip 提示

备注

note 备注

注意

warning

危险

danger

常用的技术符号​

⌘（command）、⌥（option/alt）、⇧（shift）、⌃（control）、⎋（esc） 等等

使用 <kbd> 标签来表示快捷键：

<kbd>⌘ Command</kbd> + <kbd>C</kbd>

⌘ Command + C

交互式组件​

For example, use JSX to create an interactive button:

<button onClick={() => alert("button clicked!")}>Click me!</button>

其他​

  • 加粗：**加粗**

  • 斜体：_斜体_

  • 强制换行，在行末加：<br/>

  • 表格某行内容不换行，在此行内容前、后分别加 <nobr>、</nobr>