GitBook Plugin - ComScore Theme

This is a plugin for Gitbook that uses the comScore color scheme.

Install it using: $ npm install gitbook-plugin-theme-comscore

Add to a Gitbook by including the following in book.json.

  1. {
  2. "plugins": [
  3.         "theme-comscore"
  4.     ]
  5. }

Then run the following script:

  1. npm i -g gitbook-cli // maybe need sudo permission
  2. gitbook install

How GitBook plugin works?

A plugin for GitBook is a node package that can be published on NPM.

package.json

name

The package name should begin with gitbook-plugin-. And if your plugin is a theme, it should begin with gitbook-plugin-theme-.

Examples: gitbook-plugin-mixpanel, gitbook-plugin-googleanalytics, gitbook-plugin-theme-dark

engine

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

  1. "engines": {
  2.     "gitbook": "*"
  3. }

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

  1. "engines": {
  2.     "gitbook": ">=0.3.1"
  3. }

entry point

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

“book”

Type: Object Default value: {}

“book.assets”

Type: String Default value: null

Path to the assets folder to copy

“book.js”

Type: Array Default value: []

List of javascript file to add to the html pages (relative to the assets fodler).

“book.css”

Type: Array Default value: []

List of css file to add to the html pages (relative to the assets fodler).

“book.html”

Type: Object Default value: {}

Map of position -> code, html snippets to add to each page. The code could be a fucntion.

“book.templates”

Type: Object Default value: {}

Templates to override default templates, only use this option if you want to change entirely how the book is rendered.

This object is a map: “name” -> “file”, with names:

  • “site”: page for a file from the site format
  • “page”: page for the page format

“hooks”

Type: Object Default value: {}

Map of “name” -> Function that needs to be called during build process. With names:

  • “init”: just after initialization, before generation
  • “finish”: after generation and everything is finished

Each hook can return a promise.