创建并发布一个插件

GitBook插件是在NPM上发布的遵循定义约定的节点包。

结构

package.json

package.json是用于描述 Node.js模块的清单格式。 GitBook插件建立在Node模块之上。它声明了在GitBook中运行插件所需的依赖关系，版本，所有权和其他信息。本文档详细描述了模式。

插件清单package.json也可以包含有关所需配置的详细信息。配置模式在package.json的gitbook字段中定义（该字段遵循[JSON-Schema]（http://json-schema.org）准则）：

{
    "name": "gitbook-plugin-mytest",
    "version": "0.0.1",
    "description": "This is my first GitBook plugin",
    "engines": {
        "gitbook": ">1.x.x"
    },
    "gitbook": {
        "properties": {
            "myConfigKey": {
                "type": "string",
                "default": "it's the default value",
                "description": "It defines my awesome config!"
            }
        }
    }
}

您可以从[NPM文档]（https://docs.npmjs.com/files/package.json）了解有关`package.json`的更多信息。

包名必须以gitbook-plugin-开头，而包引擎应该包含gitbook。

index.js

index.js是插件运行时的主要入口点：

module.exports = {
    // Map of hooks
    hooks: {},

    // Map of new blocks
    blocks: {},

    // Map of new filters
    filters: {}
};

发布插件

GitBook插件可以在[NPM]（https://www.npmjs.com）上发布。

要发布一个新的插件，你需要在[npmjs.com]（https://www.npmjs.com）上创建一个帐户，然后从命令行发布它：

$ npm publish

私人插件

专用插件可以在GitHub上托管，并使用git url：

{
    "plugins": [
        "myplugin@git+https://github.com/MyCompany/mygitbookplugin.git#1.0.0"
    ]
}