https://github.com/danielmschmidt/generator-gitbook
https://github.com/danielmschmidt/generator-gitbook
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/danielmschmidt/generator-gitbook
- Owner: DanielMSchmidt
- Created: 2014-04-09T18:51:16.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2018-05-22T07:33:16.000Z (about 8 years ago)
- Last Synced: 2024-11-19T21:46:59.704Z (over 1 year ago)
- Language: JavaScript
- Size: 6.84 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# generator-gitbook
## Getting Started
### What is Yeoman?
Trick question. It's not a thing. It's this guy:
Basically, he wears a top hat, lives in your computer, and waits for you to tell him what kind of application you wish to create.
Not every new computer comes with a Yeoman pre-installed. He lives in the [npm](https://npmjs.org) package repository. You only have to ask for him once, then he packs up and moves into your hard drive. *Make sure you clean up, he likes new and shiny things.*
```
$ npm install -g yo
```
### Yeoman Generators
Yeoman travels light. He didn't pack any generators when he moved in. You can think of a generator like a plug-in. You get to choose what type of application you wish to create, such as a Backbone application or even a Chrome extension.
To install generator-gitbook from npm, run:
```
$ npm install -g generator-gitbook
```
Finally, initiate the generator:
```
$ yo gitbook
```
You need to init a git repository in this folder, to be able to run the [Gitbook Commands](https://github.com/GitbookIO/gitbook#how-to-use-it).
To deploy your book to github pages do
```
grunt deploy
```
### Getting To Know Yeoman
Yeoman has a heart of gold. He's a person with feelings and opinions, but he's very easy to work with. If you think he's too opinionated, he can be easily convinced.
If you'd like to get to know Yeoman better and meet some of his friends, [Grunt](http://gruntjs.com) and [Bower](http://bower.io), check out the complete [Getting Started Guide](https://github.com/yeoman/yeoman/wiki/Getting-Started).
## License
MIT