外掛

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. 建立一個 Pull Request 並描述變更。