Docusaurus uses Markdown as its main content authoring format.
You can learn Markdown in 10 minutes.
Docusaurus uses modern tooling to help you create interactive documentation.
The MDX compiler transforms Markdown files to React components, and allows you to use JSX in your Markdown content. This enables you to easily interleave React components within your content, and create delightful learning experiences.
The MDX playground is your new best friend!
It is a very helpful debugging tool that shows how the MDX compiler transforms Markdown to React.
Options: select the right format (MDX or CommonMark) and the following plugins Docusaurus uses:
MDX vs. CommonMark
Docusaurus compiles both
.mdx files to React components using the MDX compiler, but the syntax can be interpreted differently depending on your settings.
The MDX compiler supports 2 formats:
- The MDX format: a powerful parser allowing the usage of JSX
- The CommonMark format: a standard-compliant Markdown parser that does not allow the usage of JSX
By default, Docusaurus v3 uses the MDX format for all files (including
.md files) for historical reasons.
It is possible to opt-in for CommonMark using the
siteConfig.markdown.format setting or the
format: md front matter.
If you plan to use CommonMark, we recommend the
siteConfig.markdown.format: 'detect' setting. The appropriate format will be selected automatically, based on file extensions:
.mdfiles will use the CommonMark format
.mdxfiles will use the MDX format
Markdown is a syntax that enables you to write formatted content in a readable syntax.
![图片 alt 文本](/img/docusaurus.png)
My Doc Section
Hello world message with some bold text, some italic text and a link
Markdown is declarative
Some may assume a 1-1 correlation between Markdown and HTML, e.g.,
![Preview](/img/docusaurus.png) will always become
<img src="/img/docusaurus.png" alt="Preview" />, as-is. However, that is not the case.
The Markdown syntax
![message](url) only declaratively tells Docusaurus that an image needs to be inserted here, but we may do other things like transforming a file path to URL path, so the generated markup may differ from the output of other Markdown renderers, or a naïve hand-transcription to the equivalent JSX/HTML code.
Front matter is used to add metadata to your Markdown file. All content plugins have their own front matter schema, and use the front matter to enrich the default metadata inferred from the content or other configuration.
Front matter is provided at the very top of the file, enclosed by three dashes
---. The content is parsed as YAML.
- 对象: 或者
Markdown quotes are beautifully styled:
> Easy to maintain open source documentation websites.
> — Docusaurus
Easy to maintain open source documentation websites.
Markdown can embed HTML elements, and
details HTML elements are beautifully styled:
### Details element example
<div>This is the detailed content</div>
Nested toggle! Some surprise inside...