跳到主要内容

Markdown 功能

Docusaurus 支持 Markdown 和一些额外功能

前置信息

Markdown 文档在顶部有元数据,称为前置信息

my-doc.md
---
id: my-doc-id
title: 我的文档标题
description: 我的文档描述
slug: /my-custom-url
---

## Markdown 标题

Markdown 文本加上[链接](./hello.md)

链接

支持常规 Markdown 链接,使用 url 路径或相对文件路径。

让我们看看如何[创建页面](/create-a-page)
让我们看看如何[创建页面](./create-a-page.md)

**结果:**让我们看看如何创建页面

图片

支持常规 Markdown 图片。

您可以使用绝对路径来引用静态目录中的图片(static/img/docusaurus.png):

![Docusaurus 标志](/img/docusaurus.png)

Docusaurus 标志

您也可以相对于当前文件引用图片。这对于将图片与使用它们的 Markdown 文件并置特别有用:

![Docusaurus 标志](./img/docusaurus.png)

代码块

支持带语法高亮的 Markdown 代码块。

```jsx title="src/components/HelloDocusaurus.js"
function HelloDocusaurus() {
return <h1>你好,Docusaurus!</h1>;
}
```
src/components/HelloDocusaurus.js
function HelloDocusaurus() {
return <h1>你好,Docusaurus!</h1>;
}

警告

Docusaurus 有特殊的语法来创建警告和标注:

:::tip[我的提示]

使用此很棒的功能选项

:::

:::danger[要小心]

此操作很危险

:::
我的提示

使用此很棒的功能选项