JSPM

  • Created
  • Published
  • Downloads 67
  • Score
    100M100P100Q64444F

Kickstart documentation for any project! This is the official Yeoman generator for Verb, a zero-configuration markdown documentation generator that is extremely easy to use and extend.

Package Exports

  • generator-verb

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (generator-verb) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

generator-verb NPM version Build Status

Kickstart documentation for any project! This is the official Yeoman generator for Verb, a zero-configuration markdown documentation generator that is extremely easy to use and extend.

Once installed globally, simply run:

  • yo verb to to start a new project
  • yo verb boilerplate:[foo] to use a specific boilerplate. Verb boilerplates are just sets of documents.
  • yo verb doc:[foo] to add a specific document or 'include'.

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-verb from npm, run:

$ npm install -g generator-verb

Finally, initiate the generator:

$ yo generator-verb

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.

Options

Command: --skip-install

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

Author

Jon Schlinkert

License

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


This file was generated by verb-cli on March 21, 2014.