generator-verb
Advanced tools
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.
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!
npm i -g generator-verb
Once installed globally, simply run:
yo verb to to start a new projectyo verb:doc [foo] to add a specific document or 'include'.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 allow you to add a specific file or files to an existing project.
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.
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 projecthelper: adds generic documentation for a Handlebars helper projectassembleplugin: adds generic documents for an Assemble plugingulpplugin: adds generic documents for a gulp plugingruntplugin: adds generic documents for a Grunt pluginPro tip: you can use the default boilerplate, node, by running just yo verb:boilerplate.
Visit the docs for adding custom boilerplates.
Add a test/test.js file with a starter mocha test.
Like yo verb:mocha but more basic. Just adds a test.js file in the root directory.
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.
Jon Schlinkert
Copyright (c) 2015 Jon Schlinkert
Released under the license
This file was generated by verb on February 26, 2015.
FAQs
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.
We found that generator-verb demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
An emerging npm supply chain attack that infects repos, steals CI secrets, and targets developer AI toolchains for further compromise.
Company News
Socket is proud to join the OpenJS Foundation as a Silver Member, deepening our commitment to the long-term health and security of the JavaScript ecosystem.
Security News
npm now links to Socket's security analysis on every package page. Here's what you'll find when you click through.