跳到主要内容

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 目录中的图像（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[小心]

这个操作很危险

:::
我的提示

使用这个很棒的功能选项

小心

这个操作很危险

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 !