JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 62
  • Score
    100M100P100Q64544F

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.

Custom boilerplates

We might put it on the roadmap, but currently this generator doesn't support custom boilerplates. If this is something you'd like to see supported natively, please submit a feature request or a pull request.

However, a simple alternative is to use Bower to manage your custom docs. Here is a suggested workflow to get you started:

1. Create the boilerplate

Create a new project that has the docs you want to use on other projects, and add a bower.json file with something like the following:

{
  "name": "verb-boilerplate-foo",
  "version": "0.1.0",
  "main": [
    "templates/README.tmpl.md",
    "templates/about.md",
    "templates/options.md",
    "templates/examples.md",
    "templates/authors.md"
  ]
}

See Bower.io for suggestions on customizing this file.

Oh, and don't forget to actually add the documention/templates to the directories specified in the bower.json!

2. Register the package with Bower

You'll want to visit Bower's documentation to learn how to register new packages. Also note that before registering your package it must be in a repository on GitHub where Bower can find it!

3. Using your custom boilerplate

Once your package has been created and registered with Bower, add a .bowerrc file and a bower.json file to the root of any project that will be using your new boilerplate.

In .bowerrc add the following:

{
  "directory": "docs"
}

In bower.json add the following (customize to the needs of your project):

{
  "name": "your-project-name",
  "version": "0.1.0",
  "dependencies": {
    "verb-boilerplate-foo": "~0.1.0"
  }
}

4. Install your custom boilerplate

If everything is setup properly, running bower istall at the command line should install your boilerplate in the ./docs directory of your project!

Suggestions or pull requests for improving this workflow or the project in general or welcome!

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.