Docsify 会即时生成您的文档网站。与 GitBook 不同,它不会生成静态 html 文件。相反,它会智能地加载和解析您的 Markdown 文件并将它们显示为网站。要开始使用它,您需要做的就是创建一个并将其部署到 GitHub Pages 上index.html

有关更多详细信息,请参阅快速入门指南。

Docsify

Docsify Markdown 支持

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

Element Support Notes
Headings Yes
Paragraphs Yes
Line Breaks Yes
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 No
Heading IDs Partial Automatically generated. There’s no way to set custom heading IDs.
Definition Lists No
Strikethrough No
Task Lists No
Emoji (copy and paste) Yes
Emoji (shortcodes) Yes
Highlight Yes
Subscript No
Superscript No
Automatic URL Linking Yes
Disabling Automatic URL Linking Yes
HTML Yes

另请参阅

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

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

获取书籍