跳到主要内容

Markdown 功能简介

文档是产品与用户之间的接口之一。一组精心编写和组织良好的文档可帮助您的用户快速了解您的产品。我们一致的目标是帮助您的用户尽快找到并了解他们所需的信息。

Docusaurus 2 使用现代工具来帮助您轻松地编写交互式文档。您可以嵌入 React 组件,或构建实时编码块,以便您的用户可以在现场操作代码。通过代码来吸引您的受众。这也许是吸引潜在用户的最有效方法。

在本章节中,我们将向您介绍我们所选择的工具,我们相信这些工具将帮助您构建功能强大的文档。接下来让我们为您举例说明。

Markdown 是一种语法,使您能够以一种便于阅读的语法来编写格式化的内容。

Docusaurus 支持 标准的 Markdown 语法,并使用 MDX 作为解析引擎。MDX 不仅仅能够解析 Markdown,还提供了更多功能,例如在文档内渲染 React 组件。

important

本章节假定您使用的是由 Docusaurus 官方提供的内容插件。