随着前端技术的不断发展,开源文档越来越流行。而 gitbook 是一个很好用的开源文档平台,它具有简单易用、扩展性强等特点,让写作变得更加轻松。gitbook-plugin-journal-summary 是一个自动生成日报摘要的插件,它可以帮助开发者更快速、高效地撰写笔记,同时也方便管理自己的学习记录。
npm 包安装
在使用 gitbook-plugin-journal-summary 插件之前,需要先在当前项目中安装 npm 包:
npm install gitbook-plugin-journal-summary --save
安装完成后,在 book.json
文件中加入插件配置:
{ "plugins": ["journal-summary"] }
以上就是插件的安装和配置,接下来我们来了解 gitbook-plugin-journal-summary 的使用方法。
插件使用指南
1. 配置
在 book.json
文件中配置插件的参数,例如:
-- -------------------- ---- ------- - ---------------- - ------------------ - -------- ---------- ------------- ------------- ---------- ------------- - - -
上面的配置中,我们指定了日报的标题为“前端工程师日报”,日期格式为“YYYY-MM-DD”,并且排除了 README.md 文件。
2. 生成日报
安装完插件之后,在书籍目录下执行以下命令即可生成日报:
gitbook journal-summary [bookRoot] [outputDir]
其中 bookRoot
为书籍的根目录,默认为当前目录;outputDir
为生成日报的输出目录,默认为当前目录下的 journal
目录。
比如:
gitbook journal-summary ./ ./journal
运行完成后,可以在指定的输出目录中看到生成的日报摘要 SUMMARY.md
:
-- -------------------- ---- ------- - ------- -- ---------- - --- ------------------ - --- ------------------ -- ---------- - --- ------------------ - --- ------------------
在日报摘要中,每天的文章列表是自动生成的,而且也保留了原来文章中的标题链接,方便查看具体文章内容。
总结
通过使用 gitbook-plugin-journal-summary 这个插件,我们可以方便地生成日报,同时也便于管理学习笔记,对于我们的学习和工作都有很大的帮助。尤其是对于需要定期总结、梳理自己的思路的开发者,这个插件更是一个好帮手。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6005708881e8991b448e7ed8