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

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.

We're just getting started here, we'd love to see pull requests for other types of documentation and for any kind of project!

Getting Started

Install

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:config

Add a Verb config file with:

yo verb:config foo

Where foo is one of the following:

yo verb:config md: adds a .verbrc.md file
yo verb:config yml: adds a .verbrc.yml file
yo verb:config verbfile: adds a verbfile.js file

Pro tips:

You can use the default config file, .verbrc.yml, by running just yo verb:config.
You can add a verbfile.js by running just yo verb:vf

Learn about Verb config files.

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:data

This subgenerator makes it easy to add data files to extend the context available to your templates (by default Verb processes templates using data from your project's package.json, but you can extend the data available to your templates with any JSON or YAML files by specifying them in a data property in .verbrc.yml or .verbrc.yml).

yo verb:data changelog: adds a CHANGELOG file to the root of your project, formatted as valid YAML.

yo verb:readme

Add a readme template to docs/README.tmpl.md by running yo verb:readme.

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

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