跳到主要内容

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 链接，可使用绝对路径或相对路径。

让我们看看如何 [创建一个页面](/create-a-page)。
让我们看看如何 [创建一个页面](./create-a-page.md)。

效果： 让我们看看如何 创建一个页面。

图片​

支持标准 Markdown 图片。

可以直接引用静态目录中的资源（如 static/img/docusaurus.png）：

![Docusaurus logo](pathname:///img/docusaurus.png)

Docusaurus logo

也可以使用与当前文件的相对路径，这样能把图片与文档放在一起管理：

![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>;
}

提示块（Admonitions）​

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>
);

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

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

This is Docusaurus green !

This is Facebook blue !