最近我重新试用了一下Gitbook,它是一个可以帮助我们快速创建结构化文档内容的工具。使用方法简单,入门门槛极低,任何人都可以很快掌握。
1,全局安装命令行工具
npm install -g gitbook-cli
2,创建并实例化gitbook写作项目
mkdir myBook && cd myBook
gitbook init
3,自动化生成目录
编辑vim summary.md
,例如:
# Summary
* [前言](README.md)
* [第一章](Chapter1/README.md)
* [第1节:衣](Chapter1/衣.md)
* [第2节:食](Chapter1/食.md)
* [第二章](Chapter2/README.md)
再执行gitbook init
,即可自动生成相关章节。当然也可以手动添加章节文件。
4,生成静态文件
gitbook build . ../dist/gitbook
基本上就是全局安装命令行工具,然后使用init子指令初始化结构,写完后使用build子指令生成静态文件。
生成的html文件可以直接上传到Github Pages静态网站发布,或者在云开发的静态托管空间发布。这是我在Github上发布的一本书:
网址:https://yishulun.com/books/gitbook/
左边栏是一个级联目录导航,右边是内容区。默念UI简洁大方,可以满足大多数场景的编撰需求。
我对这个工具很满意,让可以让我将精心专注于写作内容本身。在本地写作时,可以Typora撰写,写完后使用gitbook指令生成一下就可以了。
我的博客(https://yishulun.com)是基于Gridea修改的,内建了一个yarn sync指令,执行后可以直接将生成后的gitbook内容同步到线上仓库。
下一步我准备将gitbook build指令与git文件上传指令整合成一个复合指令,撰写完成后用一个指令搞定。
如果Typora支持插件开发就好了,这样就可以在Typora上加一个菜单,代替执行复合指令。但很遗憾它目前还不支持。
2021年1月12日