Noctiflorous Pansy Mulch
    Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    grunt-verbpublic

    grunt-verb NPM version

    Grunt plugin for Verb, the markdown documentation generator with zero-configuration required.

    Other Verb tools:

    • Get verb-cli to use Verb from the command line
    • Get generator-verb to add documentation templates, or initialize docs for new projects
    • Get gulp-verb for gulp workflows

    Install with npm

    npm install grunt-verb --save-dev

    You can also use the Verb generator to kickstart the documentation for any project.

    Please report any bugs or feature requests, thanks!

    Examples

    You can build any kind of markdown document with Verb, but building a readme is an easy way to get started.

    Here is an example template for a basic readme:

    {%= name %}
     
    > {%= description %}
     
    {%= toc() %}
     
    ## Overview
    {%= docs("overview") %}
     
    ## Options
    {%= docs("options") %}
     
    ## Examples
    {%= docs("examples") %}
     
    ## License and Copyright
    {%= copyright() %}
    {%= license() %}

    Contributing

    Find a bug? Have a feature request? Please create an Issue. If you find this project useful please consider "starring" it to show your support!

    In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality.

    Pull requests are also encouraged, please re-build the documentation with grunt-verb before you submit your pull request! Thanks!

    Author

    Jon Schlinkert

    License

    Copyright (c) 2014 Jon Schlinkert, contributors.
    Released under the MIT license


    This file was generated by grunt-verb on May 05, 2014.

    install

    npm i grunt-verb

    Downloadslast 7 days

    132

    version

    0.2.4

    license

    none

    repository

    github.com

    last publish

    collaborators

    • avatar