Skip to main content

user

使用手册

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

链接​

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

Let's see how to [grid 布局](/grid布局.md).
Let's see how to [grid 布局](./grid布局.md).

Result: Let's see how to grid 布局.

图像​

支持常规 Markdown 图像。

您可以使用绝对路径来引用静态目录 ( static/img/docusaurus.png) 中的图像： (static/img/docusaurus.png):

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

Docusaurus logo

代码块​

语法高亮支持 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

:::
My tip

Use this awesome feature option

Take care

This action is dangerous