UNPKG

grunt-readme

Version:

Grunt plugin for generating a README from templates, including an optional table of contents. No Gruntfile config is necessary, just choose a starter template and you'll be ready to go.

github.com/assemble/grunt-readme

assemble/grunt-readme

84 lines (59 loc) • 2.85 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
# Badges ## codeclimate ```js {%= _.codeclimate() %} // => [![Code Climate](https://codeclimate.com/github/ruby/ruby.png)](https://codeclimate.com/github/ruby/ruby) ``` ## coderwall ```js {%= _.coderwall() %} // => [![endorse](https://api.coderwall.com/jonschlinkert/endorsecount.png)](https://coderwall.com/jonschlinkert) ``` ## coveralls ```js {%= _.coveralls() %} // => [![Coverage Status](https://coveralls.io/repos/assemble/assemble/badge.png?branch=master)](https://coveralls.io/r/assemble/assemble?branch=master) ``` ## [david](https://david-dm.org/) [![dependencies](https://david-dm.org/assemble/assemble.png)](https://david-dm.org/assemble/assemble) [![devDependencies](https://david-dm.org/assemble/assemble.png/dev-status.png)](https://david-dm.org/assemble/assemble) ```js {%= _.david() %} // => [![dependencies](https://david-dm.org/assemble/assemble.png)](https://david-dm.org/assemble/assemble) // => [![devDependencies](https://david-dm.org/assemble/assemble/dev-status.png)](https://david-dm.org/assemble/assemble#info=devDependencies) ``` ## drone ```js {%= _.drone() %} // => [![](https://drone.io/assemble/assemble/status.png)](https://drone.io/assemble/assemble/latest) ``` ## fury ```js {%= _.fury() %} // => [![NPM version](https://badge.fury.io/assemble/assemble.png)](http://badge.fury.io/assemble/assemble) ``` ## nodei [![NPM](https://nodei.co/npm/assemble.png)](https://nodei.co/npm/assemble/) ```js {%= _.nodei() %} {%= _.nodei('downloads,stars', '6') %} {%= _.nodei('mini') %} {%= _.nodei('compact') %} {%= _.nodei('compact,downloads,mini,stars') %} {%= _.nodei('compact,downloads,stars') %} {%= _.nodei('compact,downloads,stars', 6) %} ``` **examples** [![NPM](https://nodei.co/npm/grunt-readme.png)](https://nodei.co/npm/grunt-readme/) [![NPM](https://nodei.co/npm/grunt-readme.png?mini=true)](https://nodei.co/npm/grunt-readme/) [![NPM](https://nodei.co/npm/grunt-readme.png?compact=true)](https://nodei.co/npm/grunt-readme/) [![NPM](https://nodei.co/npm/grunt-readme.png?downloads=true&stars=true&months=6)](https://nodei.co/npm/grunt-readme/) [![NPM](https://nodei.co/npm/grunt-readme.png?compact=true&downloads=true&mini=true&stars=true)](https://nodei.co/npm/grunt-readme/) [![NPM](https://nodei.co/npm/grunt-readme.png?compact=true&downloads=true&stars=true)](https://nodei.co/npm/grunt-readme/) [![NPM](https://nodei.co/npm/grunt-readme.png?compact=true&downloads=true&stars=true&months=6)](https://nodei.co/npm/grunt-readme/) ## travis [![Build Status](https://travis-ci.org/assemble/assemble.png?branch=master)](https://travis-ci.org/assemble/assemble) ```js {%= _.travis() %} // => [![Build Status](https://travis-ci.org/assemble/assemble.png?branch=master)](https://travis-ci.org/assemble/assemble) ```