插件

Hexo 拥有强大的插件系统,可以轻松扩展功能而无需修改核心模块的源代码。Hexo 中有两种插件

脚本

如果您的插件比较简单,建议使用脚本。您只需将您的 JavaScript 文件放在 scripts 文件夹中,Hexo 就会在初始化期间加载它们。

插件

如果您的代码比较复杂,或者您想将它发布到 NPM 注册表,建议使用插件。首先,在 node_modules 文件夹中创建一个文件夹。此文件夹的名称必须以 hexo- 开头,否则 Hexo 会忽略它。

您的新文件夹至少必须包含两个文件:一个包含实际 JavaScript 代码的文件和一个 package.json 文件,该文件描述了插件的用途并设置了它的依赖项。

.
├── index.js
└── package.json

至少,您应该在 package.json 中设置 nameversionmain 条目。例如

package.json
{
"name": "hexo-my-plugin",
"version": "0.0.1",
"main": "index"
}

您还需要在 Hexo 实例的根 package.json 中将您的插件列为依赖项,以便 Hexo 能够检测并加载它。

工具

您可以利用 Hexo 提供的官方工具来加速开发

发布

当您的插件准备就绪后,您可以考虑将其发布到 插件列表,邀请其他人开始使用它。发布自己的插件非常类似于 更新文档

  1. Fork hexojs/site

  2. 将存储库克隆到您的计算机并安装依赖项。

    $ git clone https://github.com/<username>/site.git
    $ cd site
    $ npm install
  3. source/_data/plugins/ 中创建一个新的 yaml 文件,使用您的插件名称作为文件名

  4. 编辑 source/_data/plugins/<您的插件名称>.yml 并添加您的插件。例如

    description: Server module for Hexo.
    link: https://github.com/hexojs/hexo-server
    tags:
    - official
    - server
    - console
  5. 推送分支。

  6. 创建一个拉取请求并描述更改。