verb
Version:
Verb makes it easy to build project documentation using simple markdown templates, with zero configuration required.
37 lines (25 loc) • 684 B
Markdown
## Install with [npm](npmjs.org)
```bash
npm i -g verb --save-dev
```
Now that verb is installed, add `README.tmpl.md` to the `docs/` dir in your project (this is all customizable, but let's keep it simple here), and add this to the file:
```markdown
{%= name %}
{%= description %}
# Getting started
Install with [npm](npmjs.org) `npm i -g {%= name %} --save-dev`
# Options
{%= docs("options") %}
# Examples
{%= docs("examples") %}
# Author
+ {%= author.name %}
# License
{%= copyright() %}
{%= license() %}
```
Next, run:
```bash
verb
```
That wasn't so hard, was it? (It was? [Try downloading Verb instead](https://github.com/assemble/verb/archive/master.zip))