Markdown 功能

Docusaurus支持 Markdown 和一些附加功能 。

前置事项

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 text with [links](./hello.md)

链接

使用 url 路径或相对文件路径支持正则Markdown 链接。

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文件对靠近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

:::

:::tip My tip

Use this awesome feature option

:::

:::danger Take care

This action is dangerous

:::

MDX 和 React 组件

MDX 可以让您的文档更多 交互式 ，并允许使用 React 组件在 Markdown 中：

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 !