Docusaurus is an open-source static site generator that converts Markdown files to a documentation website. Created by Facebook, Docusaurus is written in the Node.js programming language. Thousands of organizations use Docusaurus to power their documentation websites. An example of a website generated by Docusaurus is shown below.
Docusaurus uses the remarkable Markdown processor.
Docusaurus provides support for the following Markdown elements.
Element | Support | Notes |
---|---|---|
标题 | 支持 | |
段落 | 支持 | |
换行符 | 支持 | You can use a trailing backslash (\ ) instead of trailing whitespace.
|
粗体 | 支持 | |
斜体 | 支持 | |
块引用 | 支持 | |
有序列表 | 支持 | |
无序列表 | 支持 | |
代码块 | 支持 | |
水平分隔符 | 支持 | |
链接 | 支持 | |
图片 | 支持 | |
表格 | 支持 | |
围栏代码块 | 支持 | |
语法高亮 | 支持 | |
脚注 | 支持 | |
标题 ID | 部分支持 | Automatically generated. There’s no way to set custom heading IDs. |
定义列表 | 不支持 | |
删除线 | 支持 | |
任务列表 | 不支持 | |
Emoji (复制和粘贴) | 未知 | |
Emoji (简码) | 未知 | |
强调 | 不支持 | |
下标 | 不支持 | |
上标 | 不支持 | |
Automatic URL Linking | 支持 | |
Disabling Automatic URL Linking | 支持 | |
HTML | 支持 |
现在不要停下来!在下面输入你的电子邮件地址,以通过电子邮件接收新的 Markdown 教程。我们不会发送垃圾邮件!