verb
Version:
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.
22 lines (13 loc) • 1.17 kB
Markdown
> Whatever value you'd like to add to the project, we'd love to have your help! If you'd like to take a more active role, get in touch! We'd be happy to help you get started!
* If you find this project useful please consider "starring" it to show your support!
* Find a bug? Have a feature request? Please [create an Issue](https://github.com/{%= repo %}/issues)
* In lieu of a formal styleguide please take care to maintain the existing coding style
* Add unit tests for any new or changed functionality
## Pull requests
Pull requests are encouraged! This project builds its our own documentation, so please remember to build the documentation with [Verb](https://github.com/assemble/verb) before you submit your pull request! Please don't edit the readme or other docs directly, edit their respective templates instead.
### Building the docs
To build the docs, first make sure [verb-cli](https://github.com/assemble/verb-cli) is installed globally (`npm i -g verb-cli`), then just follow these simple steps:
* Edit the templates in the ['docs/' directory](./docs), and/or [.verbrc.md](./.verbrc.md)
* Run `verb` in the command line
* Pull request!
Thanks!