Giter Club home page Giter Club logo

generator-gitbook's Introduction

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 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.

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 and Bower, check out the complete Getting Started Guide.

License

MIT

generator-gitbook's People

Stargazers

MollTheCoder avatar CodeBlue avatar Angus H. avatar Átila Camurça Alves avatar Samy Pessé avatar

Watchers

James Cloos avatar  avatar

generator-gitbook's Issues

npm install error

sudo npm -g install generator-gitbook

npm ERR! System Linux 3.2.0-60-generic-pae  
npm ERR! command "/usr/bin/node" "/usr/bin/npm" "install" "-g" "generator-gitbook"  
npm ERR! cwd /home/bwaters  
npm ERR! node -v v0.10.26   
npm ERR! npm -v 1.4.3  
npm ERR! path /usr/lib/node_modules/generator-gitbook/node_modules/yeoman-generator/coverage/lcov-report/generator/lib/util/storage.js.html  
npm ERR! fstream_path /usr/lib/node_modules/generator-gitbook/node_modules/yeoman-generator/coverage/lcov-report/generator/lib/util/storage.js.html  
npm ERR! fstream_type File  
npm ERR! fstream_class FileWriter  
npm ERR! code ENOENT  
npm ERR! errno 34  
npm ERR! fstream_stack /usr/lib/node_modules/npm/node_modules/fstream/lib/writer.js:284:26  
npm ERR! fstream_stack Object.oncomplete (fs.js:107:15)  
npm ERR!   
npm ERR! Additional logging details can be found in:  
npm ERR!     /home/bwaters/npm-debug.log  
npm ERR! not ok code 0  `  

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.