Skip to main content

Markdown 功能

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

扉页​

Markdown 文档顶部包含称为 扉页 的元数据：

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 徽标](/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(`You clicked the color ${color} with label ${children}`)
    }}>
    {children}
  </span>
);

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

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

这是 Docusaurus 绿色 ！

这是 Facebook 蓝色 ！