チュートリアルはGitbookの全体のプロセスは、プラグインの開発を理解することができますホワイトgitbookスタート

プラグインとは何ですか

Gitbookプラグインがされ、拡張 GitBook機能（電子書籍やウェブサイト）で最良の方法。

限り、Gitbook デフォルトの機能が提供されていないに基づいて、プラグイン機構をすることができ、自己拡張、可能にするプラグインですGitbookはるかに強力。

gitbook・開発・アプリケーションpreview.pngも

この記事では、ます、完全に導入し、関連する知識のプラグとプラグイン開発の全体のプロセスに焦点を当てただけで、プラグインの開発プロセスに精通対象とすることを認識して、独自のプラグインを開発するために。

Plug-insについては、を参照してくださいGitbookはじめにチュートリアルシニアアドバンスド説明するために、本論文の開発に注力し、シリーズの基本的な流れを。Gitbook

gitbookは、チュートリアル紹介をプラグイン入門します

チュートリアルユーティリティプラグgitbookスタート

gitbookは、チュートリアルのテーマプラグインをはじめ

プラグインを見つける方法

あなたができます~~Gitbook公式サイト~~簡単にプラグインはまたにすることができ、検索npmjsの公式ウェブサイトの検索gitbook-plugin-<name>プラグイン。

gitbook-プラグインNPM-preview.pngも

現在、Gitbook公式はありません維持もはや介してのみ、プラグインのウェブサイトをnpmjs発見するGitbookプラグイン。

プラグインをインストールする方法

インストールしたいプラグインを見つけたら、それを追加する必要があるbook.jsonファイルは、自己作成されていない場合、設定ファイル。

{
    "plugins": ["myPlugin", "anotherPlugin"]
}

また、特定のバージョンを指定するには、次のコマンドを使用することができます[email protected]。
デフォルトのバージョンは満たしていない、GitBook使用した最新バージョン（互換性のあるバージョン）プラグイン。

プラグインをインストールします。

これがある場合の公式ウェブサイトオンライン環境、サイトが自動的にプラグインをインストールするのに役立ちます。
それはローカル環境にある場合は、直接実行する gitbook installプラグインをインストールします。

$ gitbook install

または使用npm のローカルプロジェクトにインストールするプラグインをダウンロードするには、事前に：

$ npm install gitbook-plugin-<name>

$ gitbook install

プラグインを設定します

プラグインの設定book.json設定ファイルpluginsConfig（プロパティは、あなた自身の創造ではない場合）、プロパティを
インストールされているプラグイン、最高のブラウザプラグインのドキュメントオプションの詳細については。

{
    "plugins": ["github"],
    "pluginsConfig": {
        "github": {
          "url": "https://github.com/snowdreams1006/snowdreams1006.github.io"
        }
    }
}

一部のプラグインは、プラグインの設定項目を提供していない、この工程を省略することができ、いくつかのプラグインは、文書が優先するものとプレゼンテーションをプラグインする設定項目が用意されています。

プラグインを開発する方法

GitBookプラグインはさnpm従わに掲載の伝統的な定義のnode標準に加えて、パッケージをnode外部の規範いくつかありますGitbook自己定義関連規範で。

ディレクトリ構造

Gitbook少なくとも備える最も基本的な項目のプラグ構造プロファイル package.jsonおよびエントリファイル index.js、他のディレクトリのファイル自体は、プラグインの使用に応じて変化します。

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

実際のプラグインプロジェクトが存在してもよく、わずかに異なっている_layoutsディレクトリのレイアウトassetリソースディレクトリおよびカスタムのexample例、およびdocsその上のドキュメントディレクトリ、および。

package.json

package.jsonされたnodejsコンフィギュレーション・ファイル、Gitbookプラグはまた、仕様に従って設定ファイルをプラグインに加えて、バージョン記述情報を宣言しGitbook、関連分野、続くschema次のようなガイドラインに基本的な例は次のとおりです。

{
    "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!"
            }
        }
    }
}

ことは注目に値するパッケージ名がなければなりませんgitbook-plugin-、で始まるパケットエンジンが含まれなければならないgitbookために。package.json、仕様を参照してください公式ドキュメント

index.js

index.js 以下のようにインレットプラグランタイム基本的な例です。

module.exports = {
    // 钩子函数
    hooks: {},

    // 代码块
    blocks: {},

    // 过滤器
    filters: {}
};

リリースプラグ

GitBookプラグインnpmjsの公式サイトに掲載。

プラグを解放するには、あなたの最初の必要性npmjsの公式サイトに登録したアカウントは、コマンドラインを発行します。

$ npm publish

特別なプラグイン

特別なプラグインをホストすることが可能GitHubであり、使用gitするURLを：

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

ローカルテストプラグイン

使用はnpm link、リリース前に、コマンドリファレンスの詳細あなたのプラグインをテストすることができ公文書のを

プラグインファイルフォルダ、実行します。

$ npm link

そして、あなたの本や文書ファイルのフォルダを実行します。

$ npm link gitbook-plugin-<name>

ユニットテストプラグ

gitbook-testerあなたは簡単に書くことができ、プラグインのNode.js /モカユニットテスト。

使用して、Travis各テスト実行のために/タグを提出することができます。

プラグインの概要

Gitbookプラグインの拡張であるGitbookに精通している場合、選挙の主要機能nodejsプロジェクトの開発プロセス限り、少し馴染みのように、Gitbook自分のプラグインを開発するために提供されるインタフェースのドキュメントは難しいことではありません！

gitbook-開発-cheer.jpg

うまくいけば、あなたの理解にこの記事Gitbookあなたは、ヨーヨーを作成し続けるために私を奨励するために私に肯定的なフィードバックを与えることを忘れないでください、この記事の助けを借りている場合、プラグインのヘルプは、プラグイン開発のプロセス全体を理解し、習得します！

拡張読みます

この記事はあなたを助ける場合は、手のタッチをタップしてください推奨されるメッセージを残すと、必要に応じて、個人的な数字の国民意識してくださいそれ以外にも私を修正し、「スノードリームイン技術。」

スノードリームイン技術.PNG