npm 包 gitbook-plugin-mp 使用教程

简介

gitbook-plugin-mp 是基于 GitBook 建立的微信公众号插件,可以将 GitBook 文章转换为微信公众号的图文消息,并直接同步到微信公众号,方便开发者一键发布自己的文章到微信公众号中。

安装

在安装之前请先确保你已经安装好 GitBookNode.js

打开命令行窗口,输入以下命令进行安装:

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

安装完成后,在 GitBook 的 book.json 文件中添加以下代码:

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

配置

在使用 gitbook-plugin-mp 之前,需要先配置 mp 标准格式的文章信息,文章信息需要在文章的 description 中进行配置,以下是文章信息的配置格式:

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

其中,各个配置项的含义如下:

  • title:文章标题,建议不要太长,太长的标题在微信公众号中显示效果不好;
  • thumb:文章封面图的 URL,封面图建议选择美观且与文章内容相关的图像;
  • author:文章作者,可以是单个作者,也可以是多个作者;
  • link:原文链接,一般是指文章在网站上的原始链接;
  • digest:文章摘要,简短概括文章主要内容的段落;
  • origin:是否显示原文链接,可选,默认为 true;

在文章的 description 中配置完成之后,就可以在 GitBook 中生成微信公众号图文消息了。

使用

使用 gitbook-plugin-mp 发布到微信公众号的步骤如下:

  1. 编写 Markdown 格式的文章,注意在文章的 description 中配置文章信息;
  2. 在 GitBook 中生成 HTML 文档,这里我们假设生成的文件名为 article.html
  3. 在命令行中执行以下命令将 article.html 转换为微信公众号的图文消息:
- ------------- ------- ------------ -- ------------

这里的 -o 参数表示将转换后的结果输出到指定的文件名中,这里我们将结果输出到 article.json 中。

  1. 在微信公众号后台添加图文素材,并选择导入 JSON 文件,选择 article.json 文件导入即可。

示例

- ------- --

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

总结

gitbook-plugin-mp 是一个非常实用的插件,可以快速地将 GitBook 中的文章转换为微信公众号的图文消息,方便开发者一键发布自己的文章到微信公众号中。通过本篇文章的学习,我们了解了 gitbook-plugin-mp 的安装、配置和使用方法,相信大家会在以后的开发中更加得心应手。

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


猜你喜欢

  • npm 包 glsl-decibels 使用教程

    GLSL(OpenGL Shading Language)是一门基于 C 语言的着色器语言,在 WebGL 和 OpenGL 中广泛使用。glsl-decibels 是一个 npm 包,为 GLSL ...

    2 年前
  • npm 包 loggers 使用教程

    在前端开发中,日志记录是一项非常重要的工作。人们可以通过日志记录跟踪应用程序/网站的错误和异常,并对它们进行调试和分析。 在 JavaScript 应用程序中,使用 loggers 包记录日志是很普遍...

    2 年前
  • npm 包 amcharts-jschart 使用教程

    引言 amcharts-jschart 是一款基于 JavaScript 的图表库,可用于在 Web 应用程序中绘制各种类型的图表。该库可以通过 npm 包进行安装和使用,大大方便了前端开发人员的工作...

    2 年前
  • npm 包 babel-plugin-preact-require 使用教程

    前言 在前端开发中,使用 React 是非常常见的。但是随着技术的发展和需求的不断变化,我们也需要去探索其他的 React 替代品。其中,Preact.js 就是一个非常优秀的 React 替代品,它...

    2 年前
  • npm 包 el-nunjucks 使用教程

    前言 el-nunjucks 是一个在 Nunjucks 模板引擎上封装的、适用于 Web 前端项目的 UI 组件库。它提供了一些常见的 UI 组件,如按钮、输入框、下拉框等,并已经定制好了样式和交互...

    2 年前
  • npm 包 accidentally-cyclic 使用教程

    accidentally-cyclic 是一款能够检查 JavaScript 代码中的循环依赖问题的 npm 包。在前端项目中,循环依赖是一个常见的难点问题。使用这个 npm 包,可以检测和诊断循环依...

    2 年前
  • npm 包 cerebro-hash 使用教程

    前言 在前端开发中,我们经常需要对数据进行加密或者生成哈希值。这时,我们可以利用 npm 提供的各种加密或哈希库来实现。其中,cerebro-hash 是一款非常优秀的哈希工具库,本文将详细介绍其使用...

    2 年前
  • npm 包 overdraft 使用教程

    概述 npm(Node Package Manager)是 Node.js 的包管理工具,可以通过 npm 安装、升级、卸载包,使 Node.js 应用的依赖管理得以自动化、简单化。

    2 年前
  • npm 包 x-ng2-http-interceptor-dontuse 使用教程

    简介 x-ng2-http-interceptor-dontuse 是一个 Angular 软件包,提供了 HTTP 拦截器的实现。它可以帮助我们在 Angular 中轻松地拦截 HTTP 请求,然后...

    2 年前
  • npm 包 abstract-container 使用教程

    在前端开发中,我们经常需要创建各种容器组件来放置页面元素。为了提高开发效率和代码可复用性,我们可以使用 npm 包管理器中的 abstract-container。

    2 年前
  • npm 包 jqx-bitter 使用教程

    在前端开发中,我们经常会用到一些现成的库来完成一些常见的操作,而 npm 是目前最流行的 JavaScript 包管理器,能方便地下载和管理各种不同类型的 npm 包。

    2 年前
  • npm 包 angular2-grid-jp 使用教程

    如何在你的 Angular 项目中使用 angular2-grid-jp。本文将为你提供使用该 npm 包的详细步骤和示例代码。同时,我们还将深入探讨其学习和指导意义。

    2 年前
  • npm 包 ajx 使用教程

    在前端开发中,AJAX 是不可或缺的一部分。它使网站能够通过异步请求数据,而无需刷新整个页面。而 npm 包 ajx 可以轻松地优化你的 AJAX 请求。让我们一起来学习如何使用 npm 包 ajx。

    2 年前
  • npm 包 ember-cli-custom-blueprints 使用教程

    Ember CLI Custom Blueprints 是一个非常实用的 npm 包,可以帮助前端工程师更轻松地创建和使用自定义蓝图。本文将详细介绍如何使用这个 npm 包。

    2 年前
  • npm 包 ui-grid-custom-cell-select 使用教程

    在前端开发中,我们经常需要使用表格展示数据。而在 AngularJS 框架中,ui-grid 是非常常用的展示表格的插件。在 ui-grid 中,ui-grid-custom-cell-select ...

    2 年前
  • npm 包 ssc-comp 使用教程

    什么是 ssc-comp ssc-comp 是一个 npm 包,用于实现 CSS 选择器的自动补全和提示。它能够根据当前 HTML 结构以及已有的 CSS 样式,智能地预测你要输入的选择器,并提供可能...

    2 年前
  • npm 包 akyuu-adapter-redis 使用教程

    前言 在现代 web 应用中,使用缓存来提高性能是非常重要的。而 Redis 作为一款高性能内存数据库,被广泛应用于缓存方案中。而 akyuu-adapter-redis 这个 npm 包则提供了一个...

    2 年前
  • npm 包 wolmo-core-rn 使用教程

    在前端开发中,我们通常会使用 npm 来管理我们的依赖。npm 是一个强大的包管理工具,它能让你很方便地在自己的项目中安装依赖,同时也可以发布自己的包供他人使用。 wolmo-core-rn 是一个基...

    2 年前
  • npm包 @mikeljames/svg-react-loader 使用教程

    前端开发中,SVG可用于矢量图像绘制,而在React中,我们可以用 @mikeljames/svg-react-loader将SVG转换成React组件,使得SVG的使用更加简单直观。

    2 年前
  • npm 包 laniakea 使用教程

    什么是 laniakea laniakea 是一个基于 Typescript 编写的轻量级、可扩展、易于使用的前端代码组织和构建工具。它支持使用模块化的方法编写代码,支持代码的打包、压缩和优化,在开发...

    2 年前

相关推荐

    暂无文章