Zambesi Documentation Site Generator for GitBook

The Zambezi documentation site generator for GitBook is a plugin which outputs a documentation website, in the Zambezi style.

Usage

First, install the plugin:

npm install --save-dev gitbook-plugin-zambezi-docs

Then add a file in your project root, called book.json – or if you already have a book.json – and add the plugin:

{
  "plugins": [ "zambezi-docs" ]
}

That's it! Now, if you build your documentation using [gitbook] you'll instantly have a Zambezi branded site. To test it, try running:

gitbook serve .

Configuration

There are a few things you may configure, either directly in book.json or indirectly, such as in the case of adding a project logo. A full configuration looks as such:

{
  "plugins": [ "zambezi-docs" ]
  "pluginsConfig": {
    "zambezi-docs": {
      "logo": "relative/path/to/logo.svg",
      "color": "#ff00ff"
    }
  }
}

The two configuration options are:

• "logo": Snazz up your site with a fancy logo, by pointing out the path at wich to find it! If unspecified, then any file named logo, with a common image type extension (e.g. png, jpg, or svg) will be used. If no such file exists, no logo will be displayed.

• "color": The main color that you'd like to associate with your project. This color will influence the color palette of the entire site!

---

License