GitBook 是一个托管文档网站和知识库的解决方案。简而言之,你登录 GitBook 网站并使用其基于 Web 的编辑器编写文档。或者,如果你希望保持对内容的控制,你可以将其保存在与 GitBook 集成的 git 存储库中。无论哪种方式,你都可以创建不同的网页并按逻辑顺序组织它们。当一切都按你希望的方式显示时,你可以在自定义域上发布它。
与许多项目一样,GitBook 最初是一个带有商业产品的开源工具链,但最终放弃了开源项目,转而采用新的专有且封闭源代码的产品,该产品仅在其网站上托管。开源工具链仍然可用,但由于该选项现在不受支持,因此本文仅记录新的托管选项。
GitBook 相对于 Docusaurus 等工具的优势在于,GitBook 负责构建和托管网站,并且 WYSIWYG 控件直观到 Markdown 新手也能使用。在 GitBook 网站上,实时编辑器在你键入 Markdown 格式语法后会隐藏它。编辑器有点不稳定,但除了奇怪的小 bug 之外,该网站通常适用于 Markdown 专家和没有任何 Markdown 经验的人。你还可以简单地将 Markdown 格式文本复制并粘贴到 GitBook 界面中。
GitBook 为以下 Markdown 元素提供支持。
元素 | 支持 | 备注 |
---|---|---|
标题 | 是 | |
段落 | 是 | |
换行符 | 是 | |
粗体 | 是 | |
斜体 | 是 | |
引用块 | 是 | |
有序列表 | 是 | |
无序列表 | 是 | |
代码 | 是 | |
水平线 | 否 | |
链接 | 是 | |
图片 | 是 | |
表格 | 是 | |
栅栏代码块 | 是 | |
语法高亮 | 是 | |
脚注 | 否 | |
标题 ID | 是 | |
定义列表 | 否 | |
删除线 | 是 | |
任务列表 | 是 | |
表情符号(复制并粘贴) | 未知 | |
表情符号(简码) | 未知 | |
高亮 | 否 | |
下标 | 否 | |
上标 | 否 | |
自动 URL 链接 | 是 | |
禁用自动 URL 链接 | 是 | |
HTML | 否 |
在 60 页中学习 Markdown。Markdown 指南一书专为新手和专家设计,是一本综合参考书,其中包含你入门和掌握 Markdown 语法所需的一切内容。
获取本书不要现在就停止!🚀 为 GitHub 存储库 标星,然后在下面输入你的电子邮件地址,以通过电子邮件接收新的 Markdown 教程。无垃圾邮件!