GitBook 是文档网站和知识库的托管解决方案。简而言之,您登录 GitBook 的网站并使用他们基于 Web 的编辑器来编写您的文档。或者,如果你宁愿保持对内容的控制,你可以将其保存在与 GitBook 集成的 git 存储库中。无论哪种方式,您都可以创建不同的网页并按逻辑顺序组织它们。当一切看起来都符合您的期望时,您可以在自定义域上发布它。
与许多项目一样,GitBook 最初是一个具有商业产品的开源工具链,但最终放弃了开源项目,转而采用专门托管在其网站上的新的专有和闭源产品。开源工具链仍然可用,但由于该选项现在不受支持,因此本文仅介绍新的托管选项。
与 Docusaurus 等工具相比,GitBook 的优势在于 GitBook 负责构建和托管网站,并且所见即所得的控件足够直观,可供 Markdown 新手使用。在 GitBook 网站上,实时编辑器会在您键入 Markdown 格式语法后隐藏它。编辑器有点片面,但撇开奇怪的小错误不谈,该网站通常适用于 Markdown 专家和没有任何 Markdown 经验的人。您也可以简单地将 Markdown 格式的文本复制并粘贴到 GitBook 界面中。
GitBook 支持以下 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 | No | |
| Links | Yes | |
| Images | Yes | |
| Tables | Yes | |
| Fenced Code Blocks | Yes | |
| Syntax Highlighting | Yes | |
| Footnotes | No | |
| Heading IDs | Yes | |
| Definition Lists | No | |
| Strikethrough | Yes | |
| Task Lists | Yes | |
| Emoji (copy and paste) | Unknown | |
| Emoji (shortcodes) | Unknown | |
| Highlight | No | |
| Subscript | No | |
| Superscript | No | |
| Automatic URL Linking | Yes | |
| Disabling Automatic URL Linking | Yes | |
| HTML | No |
在 60 页中学习 Markdown。《Markdown 指南》专为新手和专家设计,是一本全面的参考书,包含您入门和掌握 Markdown 语法所需的一切。
获取书籍