npm 包 gitbook-plugin-mp 使用教程

阅读时长 3 分钟读完

简介

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

纠错
反馈