Hexo插件开发
文章目录
【注意】最后更新于 September 7, 2018,文中内容可能已过时,请谨慎使用。
{% github hexojs site e1839be width = 30% %}
Hexo 有强大的插件系统,使您能轻松扩展功能而不用修改核心模块的源码。在 Hexo 中有两种形式的插件:
脚本(Scripts)
如果您的代码很简单,建议您编写脚本,您只需要把 JavaScript 文件放到 scripts
文件夹,在启动时就会自动载入。
插件(Packages)
如果您的代码较复杂,或是您想要发布到 NPM 上,建议您编写插件。首先,在 node_modules
文件夹中建立文件夹,文件夹名称开头必须为 hexo-
,如此一来 Hexo 才会在启动时载入否则 Hexo 将会忽略它。
文件夹内至少要包含 2 个文件:一个是主程序,另一个是 package.json
,描述插件的用途和所依赖的插件。
|
|
package.json
中至少要包含 name
, version
, main
属性,例如:
|
|
工具
您可以使用 Hexo 提供的官方工具插件来加速开发: hexo-fs:文件 IO hexo-util:工具程式 hexo-i18n:本地化(i18n) hexo-pagination:生成分页资料
发布
当您完成插件后,可以考虑将它发布到 插件列表,让更多人能够使用您的插件。发布插件的步骤和 更新文件 非常类似。
- Fork hexojs/site
- 把库(repository)复制到电脑上,并安装所依赖的插件:
|
|
- 编辑 source/_data/plugins.yml,在档案中新增您的插件,例如:
|
|
- 推送(push)分支.
- 建立一个新的合并申请(pull request)并描述改动。
文章作者 iTBoyer
上次更新 2018-09-07