跳到主要内容

Markdown 功能

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

Front Matter​

Markdown 文档在顶部有一个称为 Front Matter 的元数据：

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

## Markdown heading

Markdown 文本与 [链接](./hello.md)

链接​

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

让我们看看如何 [创建一个页面](/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)

Docusaurus logo

您还可以相对引用当前文件中的图片。这在将图片与 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[我的提示]

使用这个很棒的功能选项

:::

:::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 !

3689

This is an apple 🍎