外掛

Hexo 有強大的外掛系統,使您能輕鬆擴展功能而不用修改核心模組的原始碼。在 Hexo 中有兩種形式的外掛:

腳本(Scripts)

如果您的程式碼很簡單,建議您撰寫腳本,您只需要把 JavaScript 檔案放到 scripts 資料夾,在啟動時就會自動載入一次。

套件(Packages)

如果您的程式碼較複雜,或是您想要發佈到 NPM 上,建議您撰寫套件。首先,在 node_modules 資料夾中建立資料夾,資料夾名稱開頭必須為 hexo-,如此一來 Hexo 才會在啟動時載入。

資料夾內至少要包含 2 個檔案:一個是主程式,另一個是 package.json,描述套件的用途和相依套件。

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

package.json 中至少要包含 name, version, main 屬性,例如:

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

工具

您可善用 Hexo 提供的官方工具套件來加速開發:

發佈

當您完成外掛後,可以考慮將它發佈到 外掛列表,讓更多人能夠使用您的外掛。發佈外掛的步驟和 更新文件 非常類似。

  1. Fork hexojs/site

  2. 把檔案庫(repository)複製到電腦上,並安裝相依套件。

    $ git clone https://github.com/<username>/site.git
    $ cd site
    $ npm install
  3. 編輯 source/_data/plugins.yml,在檔案中新增您的外掛,例如:

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

  5. 建立一個新的合併申請(pull request)。