前言
在软件开发的世界中,我们经常需要使用各种各样的工具来帮助我们提高开发效率和质量。NPM作为一个知名的包管理工具,为我们提供了大量的npm包,而其中gitbook-plugin-gif作为一款在文档中展示动图的插件,非常实用。因此本文将会介绍如何使用该插件。
什么是 gitbook-plugin-gif
gitbook-plugin-gif是一个gitbook插件,主要用于在gitbook的markdown文档中嵌入gif图片。
安装
在安装gitbook-plugin-gif之前,需要安装Gitbook工具,如果没有,则先需要安装Gitbook。 运行以下命令进行插件安装:
$ npm install gitbook-plugin-gif
使用
编写markdown文档
首先,在需要嵌入gif图的位置,记录,例如“{gif-1}”。
这是一张动图 {gif-1} 这是一张静图
在book.json中引用
其次,在hexo的配置文件book.json的plugins字段添加如下配置,plugins字段不在的情况下需要新建。
"pluginsConfig": { "gif": { "prefix": "https://raw.githubusercontent.com/gaojunhua/gitbook-plugin-gif/master/example/" } }, "plugins": ["gif"]
其中prefix字段为gif图片的存储路径,如需修改路径,需要将路径相应修改。
添加gif图片
在相应的路径下添加需要引用的gif图片,并在book.json所指定的路径下,新建一个gif图片的与gif index文件同名的json文件, 用于保存gif的文件名。
json文件的内容为:
{ "fileNames": [ "giphy.gif" ] }
在其所指定的路径下,需要再新建一个与gif index文件同名的文件夹用于存放gif文件。
最后,在文件夹中添加gif图片,文件名需要与json文件中的相应名字匹配。
完成上述操作之后,就可以在markdown文档中使用gif图了。
示例代码
下面,我们以一个例子来具体看一下如何使用gitbook-plugin-gif。
首先,我们需要在markdown文档中添加对应的标记。
这是一张动图 {gif-1} 这是一张静图
然后,在Hexo的配置文件book.json的plugins字段添加如下配置。
{ "pluginsConfig": { "gif": { "prefix": "https://raw.githubusercontent.com/gaojunhua/gitbook-plugin-gif/master/example/" } }, "plugins": ["gif"] }
在相应的路径下,添加需要引用的gif图片,并在该路径下新建一个与gif index文件同名的json文件,如下。
{ "fileNames": [ "giphy.gif" ] }
在与index.json文件同名的文件夹下,添加与之相应的gif图片,如下图所示。
然后启动相应的gitbook服务,便可以看到页面已成功引用该gif图片。
总结
本文介绍了如何安装和使用gitbook-plugin-gif。通过本文的介绍,我们可以使用该插件在markdown文档中嵌入动态的gif图片,能够有效地提升我们的文档可读性,展示效果更佳。使用该插件不仅能够生成优秀的文档,还能够提高我们的学习效率和工作效率。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60067356890c4f7277583c84