npm 包 gitbook-plugin-journal-summary 使用教程

随着前端技术的不断发展,开源文档越来越流行。而 gitbook 是一个很好用的开源文档平台,它具有简单易用、扩展性强等特点,让写作变得更加轻松。gitbook-plugin-journal-summary 是一个自动生成日报摘要的插件,它可以帮助开发者更快速、高效地撰写笔记,同时也方便管理自己的学习记录。

npm 包安装

在使用 gitbook-plugin-journal-summary 插件之前,需要先在当前项目中安装 npm 包:

--- ------- ------------------------------ ------

安装完成后,在 book.json 文件中加入插件配置:

-
  ---------- -------------------
-

以上就是插件的安装和配置,接下来我们来了解 gitbook-plugin-journal-summary 的使用方法。

插件使用指南

1. 配置

book.json 文件中配置插件的参数,例如:

-
  ---------------- -
    ------------------ -
      -------- ----------
      ------------- -------------
      ---------- -------------
    -
  -
-

上面的配置中,我们指定了日报的标题为“前端工程师日报”,日期格式为“YYYY-MM-DD”,并且排除了 README.md 文件。

2. 生成日报

安装完插件之后,在书籍目录下执行以下命令即可生成日报:

------- --------------- ---------- -----------

其中 bookRoot 为书籍的根目录,默认为当前目录;outputDir 为生成日报的输出目录,默认为当前目录下的 journal 目录。

比如:

------- --------------- -- ---------

运行完成后,可以在指定的输出目录中看到生成的日报摘要 SUMMARY.md

- -------

-- ----------

- --- ------------------
- --- ------------------

-- ----------

- --- ------------------
- --- ------------------

在日报摘要中,每天的文章列表是自动生成的,而且也保留了原来文章中的标题链接,方便查看具体文章内容。

总结

通过使用 gitbook-plugin-journal-summary 这个插件,我们可以方便地生成日报,同时也便于管理学习笔记,对于我们的学习和工作都有很大的帮助。尤其是对于需要定期总结、梳理自己的思路的开发者,这个插件更是一个好帮手。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/6005708881e8991b448e7ed8


猜你喜欢

  • npm 包 metalsmith-handlebars 使用教程

    前言 开发一个网站需要的不仅仅是后端代码和数据库设计,前端方面的代码同样非常重要。而在前端开发中,使用合适的工具能够提高效率。本篇文章将介绍一个前端工具 -- metalsmith-handlebar...

    3 年前
  • npm 包 bfn-broadlinkjs-rm 使用教程

    导语 在如今信息化的时代,智能化已经成为了一种趋势。而家庭智能化也成为了很多家庭的选择。家庭智能化的核心在于设备间的相互连接和互动。而这其中,最主要的便是通信。bfn-broadlinkjs-rm 是...

    3 年前
  • npm 包 node-red-contrib-thinkp-sofia2 使用教程

    简介 node-red-contrib-thinkp-sofia2 是一款基于 Node-RED 开发的 npm 包,旨在为开发者提供快速接入 Sofia2 IoT 平台的工具。

    3 年前
  • npm 包 date-input-polyfill-2 使用教程

    在前端开发中,常常需要处理日期和时间的输入和展示问题。然而不同浏览器对于日期、时间等输入类型的支持程度各不相同,这就需要我们使用一些工具来实现跨浏览器的兼容性。 本文将介绍一个 npm 包 date-...

    3 年前
  • npm 包 elasticsearch-odm-5 使用教程

    Elasticsearch-odm-5 是一个基于 Node.js 的 Elasticsearch Object Document Mapper(ODM)。它可以帮助开发者更方便地在 Node.js ...

    3 年前
  • 使用 errbit-legacy npm 包管理前端错误

    前端错误是每个web开发者都必须面对的挑战之一。错误不仅会影响用户体验,还会危害到网站的安全。幸运的是,现在有许多工具可以帮助我们在网站遇到错误时快速解决问题。其中一个受欢迎的工具是 Errbit,它...

    3 年前
  • npm 包 gitbook-plugin-insert-logo-link 使用教程

    在前端开发中,文档是非常重要的,而 gitbook 是一个很好的文档写作工具,它可以方便地将 markdown 格式的文档转换成静态 HTML 页面。当然,为了让文档更加专业化和美观,我们需要自定义一...

    3 年前
  • npm 包 Malal 使用教程

    Malal 是一个基于 JavaScript 的命令行工具,可以帮助前端开发者快速创建常用的 HTML、CSS、JavaScript 文件。使用 Malal 工具可以有效提高前端开发效率。

    3 年前
  • npm 包 ledscreen 的使用教程

    简介 npm 是现代前端开发必备的工具,它可以帮助我们管理依赖库,加快项目开发速度。而 ledscreen npm 包是一款用于控制 LED 屏幕的工具,它提供了一系列 API,使得我们可以在前端页面...

    3 年前
  • npm 包 react-efl 使用教程

    什么是 react-efl? react-efl 是一款在 React 中使用 EFL(Enlightenment Foundation Libraries)的库,EFL 是一套用于构建高性能图形界面...

    3 年前
  • npm 包 melipayamak-api 使用教程

    Melipayamak 是一家提供短信服务的公司,他们提供了一个 Node.js 的 SDK,方便 Node.js 开发者调用他们的短信服务。这个 SDK 被封装成了一个 npm 包,叫做 melip...

    3 年前
  • npm 包 o2-auth-fb-service 使用教程

    OAuth 2.0 是目前用得最广泛的授权机制之一,它可以帮助开发者有效地解决身份认证的问题。近年来,随着社交媒体以及移动互联网的快速发展,越来越多的企业和开发者开始使用社交媒体的 OAuth 2.0...

    3 年前
  • npm 包 service-now-bearer 使用教程

    简介 service-now-bearer 是一个 npm 包,用于在 ServiceNow 应用中生成用于认证请求的 OAuth2 Bearer 令牌。它包含了一系列 API,可以方便地生成 Bea...

    3 年前
  • npm 包 @kellycampbell/protobufjs 使用教程

    在这个快速发展的云计算时代,许多开发人员都需要在客户端、服务器端和云平台之间传送或存储大量数据。使用 Protocol Buffers 是一种非常有效的方法,可以将您的数据结构转换为更小、更快且跨平台...

    3 年前
  • npm 包 react-ui-sortable-tree 使用教程

    前言 在前端开发中,我们经常需要使用树形结构来展示数据。而 react-ui-sortable-tree 是一个非常好用的 npm 包,可以帮助我们实现树形结构和拖动排序功能。

    3 年前
  • npm 包 geojson-properties 使用教程

    在前端开发中,我们经常需要操作地理数据。而 GeoJSON 是一个地理信息数据交换格式,在前端应用中也被广泛使用。geojson-properties 是一个 npm 包,它可以帮助我们操作 GeoJ...

    3 年前
  • npm 包 react-rest-application 使用教程

    介绍 react-rest-application 是一款用于构建基于 RESTful API 的 React 应用程序的 npm 包。这个包提供了一个易于使用的工具集,使得开发者们可以更快更简单地构...

    3 年前
  • npm 包 @machinemode/cryptopia 使用教程

    在前端开发中,加密和解密应用程序的敏感信息是非常常见的需求之一。@machinemode/cryptopia 这个 npm 包就是被设计来满足这一需求的。本文将介绍如何使用 @machinemode/...

    3 年前
  • npm 包 @geodir/builder-api 使用教程

    介绍 @geodir/builder-api 是一个基于 Node.js 的 npm 包,用于开发前端应用程序的构建过程,可以帮助开发者自动化构建、打包、部署应用程序。

    3 年前
  • npm 包 node-red-contrib-routing 使用教程

    简介 在现代的 Web 开发中,前端框架和库层出不穷。在这些框架和库的支持下,前端开发变得越来越简单和高效。 而其中 npm 包 node-red-contrib-routing 作为路由控制管理工具...

    3 年前

相关推荐

    暂无文章