verb-readme-generator

Generate your project's readme with verb. Requires verb v0.9.0 or higher.

You might also be interested in generate.

TOC

• Install
• Heads up!
• CLI
• Tasks
• Options
  • run
  • silent
  • readme
  • times
  • toc
    • layout
• Related projects
• Contributing
• Building docs
• Running tests
• Author
• License

Install

Install as a devDependency with npm:

$ npm install verb-readme-generator --save-dev

Heads up!

This generator requires verb 0.9.0 and up, which is currently on the dev branch. If you're willing to put up with occassional bugs and would like to provide helpful feedback, install verb with the following command:

$ npm i -g "verbose/verb#dev"

CLI

Installing the CLI

To run the readme generator from the command line, you'll need to install verb globally first. You can that now with the following command:

$ npm i -g verb

This adds the verb command to your system path, allowing it to be run from any directory. Visit the verb project and documentation to learn more.

Run the readme generator from the command line

Once both verb and verb-readme-generator are installed globally, you can run the generator with the following command:

Run the readme generator from the command line:

$ verb readme

Tasks

data

Loads data to used for rendering templates. Called by the readme task.

Example

$ verb readme:data

new

Add a .verb.md template to the current working directory.

Example

$ verb readme:new

verbmd

Load the .verb.md in the user's current working directory. If no .verb.md file exists, the [prompt-verbmd)() task is called to ask the user if they want to add the file. Disable the prompt by passing --verbmd=false on the command line, or app.disable('verbmd') via API.

Example

$ verb readme:verbmd

prompt-verbmd

Prompts the user to add a new .verb.md template to the current working directory. Useful in sub-generators.

Example

$ verb readme:prompt-verbmd

ask

User-friendly alias for the prompt-verbmd task. (This task is aliased with both a terse and long-form name so that in the case this generator is inherited by another and the generator already has an ask task, the prompt-verbmd task will still be available to use via API.)

Example

$ verb readme:ask

templates

Load layouts, includes and badges commonly used for generating a README.md.

Example

$ verb readme:templates

readme

Generate a README.md from a .verb.md template. Runs the middleware, templates, and data tasks. This is a verb task.

Example

$ verb readme

default

Alias for the readme task, generates a README.md to the user's working directory.

Example

$ verb readme

Options

Configuration options can be passed on the command line, defined on the verb object in package.json, or set using the API.

Most of the following examples show how to set configuration values on the verb object via the command line, but you can also set these manually.

run

To automatically run the readme generator with the verb command (without specifying readme on the command line), add the following to package.json:

// --package.json--
{
  // add a verb object with an array of tasks to run
  "verb": {
    "tasks": ["readme"]
  }
}

silent

Mute progress for tasks and generators from being displayed in the terminal.

CLI

$ verb --silent

verb config

In your project's package.json:

{
  "verb": {
    "silent": true
  }
}

API

In your verbfile.js or application code:

app.enable('silent');
 
// equivalent to
app.option('silent', true);

Examples

With --silent

readme

Customize the location of your readme template.

CLI

$ verb --readme="lib/foo.md"

verb config

In your project's package.json:

{
  "verb": {
    "readme": "docs/foo.md"
  }
}

times

Display all timings that are typically muted in the terminal.

CLI

$ verb --times

verb config

Always show timings for a project by adding the following to package.json:

{
  "verb": {
    "times": true
  }
}

API

In your verbfile.js or application code:

app.enable('times');
// equivalent to
app.option('times', true);

toc

Disable or enable the Table of Contents in the built-in layouts:

CLI

One-time only (in-memory)

# enable 
$ verb --toc
# disable 
$ verb --toc:false

Persist the value to package.json:

# enable 
$ verb --config=toc
# disable 
$ verb --config=toc:false

Results in:

{
  "name": "my-project",
  "verb": {
    "toc": false
  }
}

layout

Set the layout to use for a project.

$ verb --config=layout:default

Available layouts

As with all templates, you can easily override these and/or define your own templates in a verbfile.js. Verb does much more than generate readme's!

The following layouts are available:

• default: a layout with installation, tests, author, usage, related list, contributing and license sections.
• global: same as default, but with global npm installation instructions (verb-readme-generator uses this layout)
• empty: noop layout. no content is applied, but all layout-related middleware stages will still run.

Layouts can be defined on a template-by-template basic, and even for includes. If you need more granularity just add a verbfile.js with your custom code.

Related projects

You might also be interested in these projects:

• verb-collections: Verb plugin that adds includes, layouts, badges and docs template collections. Can be used with… more | homepage
• verb-data: Verb plugin that adds commonly needed data to the context for rendering templates. | homepage
• verb-toc: Verb generator that adds middleware for creating and injecting a table of contents into a… more | homepage
• verb: Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used… more | homepage

Contributing

This document was generated by verb, please don't edit directly. Any changes to the readme must be made in .verb.md. See Building Docs.

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

Generate readme and API documentation with verb:

$ npm install -g verb verb-readme-generator && verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2016, Jon Schlinkert. Released under the MIT license.

This file was generated by verb, v0.9.0, on May 30, 2016.