跳转到主要内容

撰写文件

您可以使用 GitHub 风格的 Markdown 语法 编写内容。

Markdown 语法#

在设计基于 markdown 的 Docusaurus 网站时,用作示例页面。

标题#

H1 - 创建最佳文档#

H2 - 创建最佳文档#

H3 - 创建最佳文档#

H4 - 创建最佳文档#

H5 - 创建最佳文档#
H6 - 创建最佳文档#

重点#

强调:又称斜体,可在文字前后添加 单星号下划线

重点突出:又称黑体,可在文字前后添加 双星号下划线

组合强调:可在文字前后同时添加 双星号和下划线

删除线:在文字前后添加两个波浪号 这是啥东东?


目录#

  1. 首个目录项
  2. 另一目录项
    • 无序号子目录
  3. 实际数字并不重要,只是一个数字
    1. 有序号子目录
  4. 再一个目录项
  • 无序子目录可以使用星号
  • 或减号
  • 或加号

链接#

内嵌型链接

标题内嵌型链接

参考型链接

用数字定义的参考型链接

或留空并使用链接文本本身

URL和尖括号中的URL,将自动变为链接。 http://www.example.com/http://www.example.com/ ,有时是 example.com(举例,不在 GitHub 上)。

一些文本表明参考链接可以在以后使用。


图片#

这是我们的标志(悬停以查看标题文本):

内嵌型: alt text

参考型: alt text

通过提供文件路径,可以使用任何文件夹中的图像。路径应指向 markdown 文件。

![img]{useBaseUrl('/static/img/logo.svg')}


代码#

var s = 'JavaScript syntax highlighting';
alert(s);
s = "Python syntax highlighting"
print(s)
No language indicated, so no syntax highlighting.
But let's throw in a <b>tag</b>.
function highlightMe() {
console.log('This line can be highlighted!');
}

表格#

冒号(:),可用于列的对齐,示例如下:

TablesAreCool
col 3 isright-aligned\$1600
col 2 iscentered\$12
zebra stripesare neat\$1

每个标题单元格,至少须有 3 个破折号(-)。 外框线(|)是可选的,您不需要把原始 Markdown 排列得很漂亮(会自动排列整齐)。 您也可以使用内嵌 Markdown 。

MarkdownLessPretty
Stillrendersnicely
123

块引用#

电子邮件中的块引用非常有用,可以模拟回复文本。该行是同一引用的一部分。

引用断开

这一行很长,当它换行时仍会被正确引用。 哦,boy,让我们继续,确保它够长,以满足所有人的实际需要。哦,您也可以将 Markdown 放入 块引用中。


内嵌 HTML#

定义清单
是人们有时会用到的东西。
Markdown 在 HTML 中
*不* 是 **很** 好用。使用 HTML 标记

换行#

这是我们要开始的第一行。

本行与上面一行之间,有两个换行符,因此它将成为一个单独段落

本行也是一个单独段落,但是......这一行只用一个换行符隔开,所以它是同一段落 中的单独一行。


告诫#

注:请保持题头:note、tip、important、caution 和 warning 为原始英文状态,内容可根据您的需要撰写。

note

This is a note

tip

This is a tip

important

This is important

caution

This is a caution

warning

This is a warning