node package manager
Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »


{{generator-docs}} NPM version Build Status

Yeoman generator for Writer. Generate project documentation templates or a README template for Writer to build.

Getting Started

If you don't already have Yeoman installed, you must first run the following to be this generator:

$ npm install -g yo

Once Yeoman is installed, to install generator-docs from npm, run:

$ npm install -g generator-docs

Finally, initiate the generator:

$ yo generator-docs

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.


Command: --skip-install

Skips the automatic execution of bower and npm after scaffolding has finished.


Jon Schlinkert



Copyright (c) 2014 Jon Schlinkert, contributors. Released under the MIT license

This file was generated by Writer on March 10, 2014.