Skip to content

Latest commit

 

History

History
101 lines (57 loc) · 3.29 KB

README.md

File metadata and controls

101 lines (57 loc) · 3.29 KB
Raw

generator-verb NPM version

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

Pull requests welcome!

Getting Started

Install globally with npm:

npm i -g generator-verb

Usage

Once installed globally, simply run:

  • yo verb to to start a new project
  • yo verb:doc [foo] to add a specific document or 'include'.

yo verb

Running the generator with yo verb will add the following files to your project:

  • .verbrc.md: a markdown-runtime config file for Verb. YAML front-matter can be used for config, and the markdown content is used to generate your project's README.md.
  • package.json: with minimal properties defined. However, if this alredy exists verb will be added to devDependencies.

Sub-generators

Sub-generators allow you to add a specific file or files to an existing project.

yo verb:doc

Add a specific document with:

yo verb:doc foo.md

Where foo.md is the name of the file you want to add. If the name used matches an actual file in verb-readme-includes, then that file will be copied into the docs/ directory of your project.

If the name doesn't match a valid file in verb-readme-includes, then a new "starter" document will be created using the given file name.

yo verb:boilerplate

Use a boilerplate to kickstart documentation for a project. Boilerplates include a README.tmpl.md template and a few includes, such as install.md, options.md etc.

yo verb:boilerplate foo

Where foo is the name of the boilerplate you want to use from verb-boilerplates.

Valid yo verb:boilerplate arguments are:

  • node: adds generic documentation for a Node.js project
  • helper: adds generic documentation for a Handlebars helper project
  • assembleplugin: adds generic documents for an Assemble plugin
  • gulpplugin: adds generic documents for a gulp plugin
  • gruntplugin: adds generic documents for a Grunt plugin

Pro tip: you can use the default boilerplate, node, by running just yo verb:boilerplate.

Visit the docs for adding custom boilerplates.

yo verb:mocha

Add a test/test.js file with a starter mocha test.

yo verb:test

Like yo verb:mocha but more basic. Just adds a test.js file in the root directory.

Generator options

Command: -s | --skip-install

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

Command: -w | --skip-welcome-message

Skips the Yeoman welcome message.

Author

Jon Schlinkert

License

Copyright (c) 2015 Jon Schlinkert
Released under the license

This file was generated by verb on February 26, 2015.