Markdown 功能

Docusaurus 支持 Markdown 和一些 额外功能。

前置信息

Markdown 文档顶部包含名为 前置信息 的元数据

my-doc.md

---
id: my-doc-id
title: My document title
description: My document description
slug: /my-custom-url
---

## Markdown heading

Markdown text with [links](./hello.md)

链接

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

Let's see how to [Create a page](/create-a-page).

Let's see how to [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>Hello, Docusaurus!</h1>;
}
```

src/components/HelloDocusaurus.js

function HelloDocusaurus() {
  return <h1>Hello, Docusaurus!</h1>;
}

警示框

Docusaurus 有一套特殊的语法来创建警示框和突出显示。

:::tip[My tip]

Use this awesome feature option

:::

:::danger[Take care]

This action is dangerous

:::

我的提示

使用这个很棒的功能选项

注意

此操作很危险

MDX 和 React 组件

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

export const Highlight = ({children, color}) => (
  <span
    style={{
      backgroundColor: color,
      borderRadius: '20px',
      color: '#fff',
      padding: '10px',
      cursor: 'pointer',
    }}
    onClick={() => {
      alert(`You clicked the color ${color} with label ${children}`)
    }}>
    {children}
  </span>
);

This is <Highlight color="#25c2a0">Docusaurus green</Highlight> !

This is <Highlight color="#1877F2">Facebook blue</Highlight> !

这是 Docusaurus 绿色 ！

这是 Facebook 蓝色 ！