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

Result: Let's see how to Create a page.

的图片

支持常规Markdown图像。 添加一个图像在 static/img/docusaurus.png ，并显示它在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

:::

My tip

Use this awesome feature option

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 !