跳到主要内容

Markdown功能

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

前置元数据​

Markdown文档在顶部有称为前置元数据的元数据：

my-doc.md
---
id: my-doc-id
title:  我的文档标题
description: 我的文档描述
slug: /my-custom-url
---

## Markdown标题

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

链接​

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

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

结果： 让我们看看如何创建页面。

图片​

支持常规的Markdown图片。

在static/img/docusaurus.png中添加一张图片并在Markdown中显示：

![Docusaurus标志](/img/docusaurus.png)

Docusaurus标志

代码块​

支持带有语法高亮的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(`您点击了颜色为${color}，标签为${children}的选项`)
    }}>
    {children}
  </span>
);

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

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

这是Docusaurus绿色！

这是Facebook蓝色！