轻松记录您
灵感和创意

Gitbook的SUMMARY构建markdown文件工具

Summarybuilder 是一个针对类似Gitbook类的书籍撰写工具提供的辅助工具,可以批量生成目录,批量创建Markdown文件,同时可以搭配开发自动化构建器(gulp.js、grunt.js等)使用,做到自动化处理生成目录和创建文件这两件事情。用过Gitbook这类工具的朋友都知道,目录和文件一一对应是很重要的,而当文件变多时,管理起来就很头疼了。summarybuilder并不能帮你做更多,至少能帮你自动化处理这些事情(生成目录和创建文件)。

目前,summarybuilder已经更新到 1.4.0 。为了让开发者能够方便和自动化工具以及自主化使用,特意增加了对应的模块API:

一、 SBer_summary()——批量生成目录。

二、SBer_createMD()——批量创建目录中的Markdown文章(已经存在的文章文件会忽略跳过)。

下图是在 gulpfile.js 中使用 summarybuilder 的例子:

gulpfile.js中使用summarybuilder

同时,summarybuilder 支持命令化使用。下图是以命令形式使用的例子:

summarybuilder命令

基本就是这两种用法,具体可以在开源平台查看它的README说明。作者显然是英语不好的入门 JSer !这样的好处就是使用说明文档看起来顺眼很多,至少不用自己去翻译。还有就是作者的要打赏的方式很特别:

微信打赏已经不分国度了吗?

他居然用微信打赏作为捐助方式,不过这也不奇怪,我还见过用比特币作为捐助方式的。哈哈,他的打赏描述也很特别。照他的说法,程序员的技艺超群是以掉发作为代价换取的。如果可以的话,不要吝啬,给我们可爱的程序员们点个赞吧。好了,我来说说怎么安装吧。

安装:

summarybuilder 托管在 npm 平台,使用 npm 命令安装即可。

全局安装:npm install -g summarybuilder

安装到项目: npm install –save summarybuilder

未经允许不得转载:坚果云Markdown编辑器 » Gitbook的SUMMARY构建markdown文件工具
分享到: 更多 (0)

坚果云Markdown轻松记录您 灵感和创意

坚果云Markdown下载坚果云Markdown介绍