Skip to main content

Markdown 特性

Docusaurus 支持 Markdown 和一些 附加特性。

前置元数据​

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

Docusaurus 标志

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

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

代码块​

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

```jsx title="src/components/HelloDocusaurus.js"
function HelloDocusaurus() {
  return <h1>Hello, Docusaurus!</h1>;
}
```
src/components/HelloDocusaurus.js
function HelloDocusaurus() {
  return <h1>Hello, 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> !

这是 Docusaurus 绿色 !

这是 Facebook 蓝色 !