Getting Started

About this documentation Installation and Setup

Your Content

Directory structure Pages and Summary Configuration Glossary Multi-Lingual Markdown AsciiDoc eBook and PDF

Customization

Templating Plugins Create a plugin Hooks Blocks Filters API & Context Test your plugin Theming
FAQ Examples Release notes

Testing your plugin

Testing your plugin locally

Testing your plugin on your book before publishing it is possible using npm link.

In the plugin's folder, run:

$ npm link

Then in your book's folder:

$ npm link gitbook-plugin-<plugin's name>

Unit testing on Travis

gitbook-tester makes it easy to write Node.js/Mocha unit tests for your plugins. Using Travis.org, tests can be run on each commits/tags.

Previous: API & Context Next: Theming

results matching ""

    No results matching ""