https://github.com/zambezi/gitbook-plugin-zambezi-docs

Zambezi Documentation Site Generator for GitBook
https://github.com/zambezi/gitbook-plugin-zambezi-docs

Last synced: 12 days ago
JSON representation

Zambezi Documentation Site Generator for GitBook

• Host: GitHub
• URL: https://github.com/zambezi/gitbook-plugin-zambezi-docs
• Owner: zambezi
• Created: 2015-10-26T23:21:59.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2016-08-09T10:36:01.000Z (over 8 years ago)
• Last Synced: 2024-11-19T11:03:19.382Z (about 1 month ago)
• Language: JavaScript
• Homepage:
• Size: 309 KB
• Stars: 0
• Watchers: 6
• Forks: 0
• Open Issues: 13
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
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:

```sh

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:

```json

{

  "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:

```sh

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:

```json

{

  "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](LICENSE)