Markdown 特性

Docusaurus 支持 Markdown 和一些其他功能。

Front Matter

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

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 logo](/img/docusaurus.png)

你也可以相对于当前文件引用图像。这对于将图像与使用它们的 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>;
}

提示框

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> !

This is Docusaurus green !

This is Facebook blue !