Skip to content

Latest commit

 

History

History
79 lines (56 loc) · 2.19 KB

.verbrc.md

File metadata and controls

79 lines (56 loc) · 2.19 KB
Raw
username license_
AndreasPizsa
MIT

{%= name %} {%= badge('fury') %} {%= badge('travis') %}

{%= description %}

About

{%= docs('about.md') %}

Example

{%= docs('example.md') %}

Install

 npm install {%= name %} --save-dev

Usage

API and Command Line

See the literature API and CLI tool.

Usage with Gulp

gulpfile.js

var literature= require('gulp-literature');
var gulp      = require('gulp');
var jshint    = require('gulp-jshint');

gulp.task('compile',function(){
  return gulp.src('test/fixtures/unfenced-code.js.md')
    .pipe(literature())
    .pipe(jshint())
});

Issues

{%= include("report-issues") %}

Contribute

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 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 is installed globally (npm i -g verb-cli), then just follow these simple steps:

Thanks!

Author

{% if(typeof authors !== 'undefined') { %}{%= include("authors") %} {% } else { %}{%= include("author") %}{% } %}

{% if(typeof contributors !== 'undefined') {%}## Contributors {%= include("contributors") %}

{% } %}

License

{%= copyright() %} Released under the {%= license_ %} license.

{%= include("footer") %}