Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

GitbookIO/plugin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

History

28 Commits

Repository files navigation

GitBook Sample Plugin

This is a model for GitBook plugins.

How GitBook plugin works?

A plugin for GitBook is a node package that can be published on NPM. It has to follow the name convention: gitbook-plugin-*name*.

package.json

name

The package name should begin with gitbook-plugin-.

Examples: gitbook-plugin-mixpanel, gitbook-plugin-googleanalytics.

engine

The package.json should contain a engine field using the standard norm.

"engines": {
 "gitbook": "*"
}

For example if you want your plugin to supports only GitBook version supperior to 0.3.1:

"engines": {
 "gitbook": ">=0.3.1"
}

entry point

The plugin entry point should return an object with some metadata.

About

Sample plugin for GitBook

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 7

AltStyle によって変換されたページ (->オリジナル) /