# guidebook

The `guidebook` module (and CLI) is a simple way to enable interaction with
your markdown sources for a [leanpub](https://leanpub.com) authored books
with an interactive guidebook.  This approach has been developed for working
with the [rtc.io](http://rtc.io/) modules and as such uses a browser based
interface.


[![NPM](https://nodei.co/npm/guidebook.png)](https://nodei.co/npm/guidebook/)

[![experimental](https://img.shields.io/badge/stability-experimental-red.svg)](https://github.com/badges/stability-badges) 

## Why?

Because I don't like doing things more than once, and it seemed like most of
the component pieces were available to make this possible.

## Usage

Once you have installed guidebook on your local machine, then you should be
able to run the `guidebook` command in a leanpub compatible folder.

## Included Fonts

Please note that the guidebook default rendering and installable module
includes the following fonts sourced from
[Google Fonts](http://www.google.com/fonts):

- Inconsolata (Ralph Levein - SIL Open Font License, 1.1)
- Roboto Slab (Christian Robertson - Apache 2.0)
- Source Code Pro (Paul D. Hunt  - SIL Open Font License, 1.1)

Fonts are distributed under their original licenses.

## License(s)

### ISC

Copyright (c) 2014, Damon Oehlman <damon.oehlman@gmail.com>

Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
PERFORMANCE OF THIS SOFTWARE.
