Docusaurus 是一个开源的静态网站生成器,可以将 Markdown 文件转换为文档网站。Docusaurus 由 Facebook 创建,是用 Node.js 编程语言编写的。数以千计的组织使用 Docusaurus 来支持他们的文档网站。下面显示了一个由 Docusaurus 生成的网站示例。

Docusaurus 使用了卓越的 Markdown 处理器。

Example of Docusaurus website

Docusaurus Markdown 支持

Docusaurus 为以下 Markdown 元素提供支持。

Element Support Notes
Headings Yes
Paragraphs Yes
Line Breaks Yes You can use a trailing backslash () instead of trailing whitespace. \
Bold Yes
Italic Yes
Blockquotes Yes
Ordered Lists Yes
Unordered Lists Yes
Code Yes
Horizontal Rules Yes
Links Yes
Images Yes
Tables Yes
Fenced Code Blocks Yes
Syntax Highlighting Yes
Footnotes Yes
Heading IDs Yes
Definition Lists No
Strikethrough Yes
Task Lists Yes
Emoji (copy and paste) Yes
Emoji (shortcodes) Yes
Highlight No
Subscript No
Superscript No
Automatic URL Linking Yes
Disabling Automatic URL Linking Yes
HTML Yes

另请参阅

将您的 Markdown 技能提升到一个新的水平。

在 60 页中学习 Markdown。《Markdown 指南》专为新手和专家设计,是一本全面的参考书,包含您入门和掌握 Markdown 语法所需的一切。

获取书籍