跳到主要内容

Markdown 功能

Docusaurus 支持 Markdown 以及一些 附加功能。

Front Matter​

Markdown 文档顶部有称为 Front Matter 的元数据：

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

## Markdown 标题

带有 [链接](./hello.md) 的 Markdown 文本

链接​

支持常规 Markdown 链接，可以使用 URL 路径或相对文件路径。

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

结果： 让我们看看如何 创建一个页面。

图片​

支持常规 Markdown 图片。

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

![Docusaurus logo](/img/docusaurus.png)

Docusaurus logo

您也可以引用相对于当前文件的图片。这对于将图片与使用它们的 Markdown 文件放在一起特别有用：

![Docusaurus logo](./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>;
}

提示 (Admonitions)​

Docusaurus 有一种特殊的语法来创建提示和标注：

:::tip[我的提示]

使用这个很棒的功能选项

:::

:::danger[注意]

此操作很危险

:::
我的提示

使用这个很棒的功能选项

注意

此操作很危险

MDX 和 React 组件​

MDX 可以让您的文档更具 交互性，并允许在 Markdown 中使用任何 React 组件：

export const Highlight = ({children, color}) => (
  <span
    style={{
      backgroundColor: color,
      borderRadius: '20px',
      color: '#fff',
      padding: '10px',
      cursor: 'pointer',
    }}
    onClick={() => {
      alert(`您点击了颜色 ${color}，标签为 ${children}`)
    }}>
    {children}
  </span>
);

这是 <Highlight color="#25c2a0">Docusaurus 绿</Highlight>！

这是 <Highlight color="#1877F2">Facebook 蓝</Highlight>！

这是 Docusaurus 绿！

这是 Facebook 蓝！