天天看点

小技巧:用 GitBook 组织 Markdown 文档

喜欢用 Markdown 写文档,那怎么把一个个 Markdown 文档组成在一起呢?

这篇文章,分享了一个用 GitBook 来组织 Markdown 文档的办法。一起了解下吧。

Markdown 是一种轻量级标记语言。只需人们纯文本编写文档,加上点标记符号,就能转成有格式的文档(如 HTML 富文本)。已广泛应用在笔记、文档、博客、出书等。2016 年 RFC 7763 开始也引入了 MIME 类型 <code>text/markdown</code> 。

安装 Node.js: https://nodejs.org/

安装 GitBook: https://www.npmjs.com/package/gitbook

最终,终端里可执行 <code>gitbook</code> :

<code>README.md</code> 是 GitBook 的必要文件
<code>SUMMARY.md</code> 是 GitBook 的必要文件

编辑组织已经存在的 Markdown 文档路径。新建的项目,则写预想的文档结构。

依照 <code>SUMMARY.md</code> ,创建新项目的文档结构。

浏览器打开 http://localhost:4000 ,即可预览。效果如下:

小技巧:用 GitBook 组织 Markdown 文档

默认生成 HTML 文档,在 <code>_book</code> 目录。如果要生成其他格式,需要安装 <code>ebook-convert</code> 插件。

安装 Calibre: https://calibre-ebook.com/download ,并配置好终端 <code>ebook-convert</code> 命令。

Ubuntu 直接安装:

macOS 下载安装,并配置软链接:

最终,终端里可执行 <code>ebook-convert</code> :

小技巧:用 GitBook 组织 Markdown 文档

Go coding!

继续阅读