A project without documentation is like a project that doesn't exist. Verb solves this by making it dead simple to generate docs, using simple markdown templates, with zero configuration required.
- Use Verb to generate and maintain markdown documentation for your projects. Use Assemble to generate a website from your Verb docs!
- Get verb-cli to use Verb globally from the command line
- Get generator-verb to add documentation templates, or initialize docs for new projects
- Read the documentation to learn more about Verb.
Install with npm:
npm i verb --saveVerb's CLI makes kickstarting new markdown documentation a breeze.
For example, to generate a readme for your project just add docs/README.tmpl.md with the following:
# {%= name %}
> {%= description %}
Sed ut perspiciatis unde omnis iste natus error sit voluptatem
accusantium doloremque laudantium, totam rem aperiam.
Then run verb in the command line and it will generate README.md, automatically using data from your project's package.json to process templates.
Need more than simple variables, like date()? Use one of Verb's built-in tags:
## License
Copyright (c) {%= date('YYYY') %} {%= author.name %}, contributors.
Released under the {%= license.type %} license
Easily include other documents. To use any markdown file in the docs/ directory just use {%= docs() %}:
## Contribute
{%= docs("contributing") %}
That's it! See this gist for a more detailed example.
This is just a simple example though, Verb can easily build multi-page markdown documentation, with a fully-linked multi-page TOC, or even build a book!
(Verb builds its own docs (WIP) too, check progress in the docs directory!).
Verb is easy to extend, here are some examples (verb-cli will automatically use these):
- example verbfile, with custom
src,destand metadata. - example verbfile with logging
- example .verbrc.yml
- Use grunt-verb with your favorite JavaScript task runner.
- Use gulp-verb with your streaming build systems.
Run Verb's 75+ unit tests:
mocha -R spec
DATE VERSION CHANGES
- 2014-03-29 v0.2.0 Changes the delimiter escaping format to be similar to Yeoman.,Adds documentation. Fixes and adds tests for front matter.
- 2014-03-10 v0.1.0 First commmit.
All contributions are welcome! Stars and tweets are always a great way to show your support! But we can definitely use some help with:
Or whatever value you'd like to add to the project! If you'd like to take a more active role, get in touch! We'd be happy to help you get started!
This project builds its our own documentation, so don't edit the readme or other docs directly, edit their respective templates instead.
To build the docs, first make sure verb-cli is installed globally (npm i -g verb-cli), then just follow these simple steps:
- Edit the templates in the 'docs/' directory
- Run
verb - Pull request!
Thanks!
Jon Schlinkert
Copyright (c) 2014 Jon Schlinkert, contributors.
Released under the MIT license
This file was generated by verb-cli on March 31, 2014.