You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Documentation build system for GitHub projects, powered by node.js. Verb has full support for gulp and assemble plugins and can be used to create documentation generators, themes, documentation websites and much more!
8
+
Verb is a documentation build system for GitHub projects powered by node.js. Verb has full support for [gulp](https://gulpjs.com/) and assemble plugins and can be used to create documentation generators, themes, documentation websites and much more!
A project without documentation is like a project that doesn't exist. Verb solves this by making it dead simple to generate documentation, using simple markdown templates, with zero configuration required.
17
15
18
-
## What is verb?
16
+
## What can Verb do?
19
17
20
18
**Documentation system**
21
19
@@ -42,7 +40,7 @@ For example, [verb-generate-readme](https://github.com/verbose/verb-generate-rea
42
40
**Templating**
43
41
44
42
* Render templates with any node.js engine, including [handlebars](http://www.handlebarsjs.com/), [lodash](https://lodash.com/), [nunjucks](https://github.com/mozilla/nunjucks), and all [consolidate](https://github.com/visionmedia/consolidate.js) engines.
45
-
* Convert markdown to HTML, or render markdown templates back to markdown (see [.verb.md](#verbmd))
43
+
* Convert markdown to HTML, or render markdown templates back to markdown
46
44
* Template collections
47
45
* Support for "pages", "partials", and "layouts"
48
46
* Helper support (sync and async!)
@@ -56,7 +54,7 @@ For example, [verb-generate-readme](https://github.com/verbose/verb-generate-rea
56
54
57
55
**Plugins**
58
56
59
-
Verb has rich plugin support, along with native support for [gulp plugins][], so if you want to publish a documentation site, you can do things like:
57
+
Verb has rich plugin support, along with native support for [gulp plugins](https://gulpjs.com/plugins/), so if you want to publish a documentation site, you can do things like:
60
58
61
59
* Ignore files marked as "drafts"
62
60
* CSS minification or reduction
@@ -66,13 +64,13 @@ Verb has rich plugin support, along with native support for [gulp plugins][], so
66
64
* Image compression
67
65
* HTML minification and linting
68
66
* RSS feeds
69
-
* Anything else you can do with [gulp plugins][]
67
+
* Anything else you can do with [gulp plugins](https://gulpjs.com/plugins/)
70
68
71
69
**Generators**
72
70
73
71
Verb supports [generate](https://github.com/generate/generate) generators, which are plugins that are registered by name and can be run by command line or API. Generators can also be published to npm and installed globally or locally.
74
72
75
-
See the [generate](https://github.com/generate/generate) project and [documentation](https://github.com/generate/generatedocs)for more details.
73
+
See the [generate](https://github.com/generate/generate) project for more details.
76
74
77
75
## Table of Contents
78
76
@@ -107,7 +105,7 @@ _(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](
107
105
To use verb's CLI, you will first need to install it globally. You can do that now with the following command:
108
106
109
107
```sh
110
-
$ npm --global install verb
108
+
$ npm --global install verb
111
109
```
112
110
113
111
This adds the `verb` command to your system path, allowing it to be run from any directory.
@@ -169,7 +167,7 @@ When a function is exported, we refer to these as [verb generators](#generators)
169
167
170
168
```js
171
169
module.exports=function(app) {
172
-
// "app" is an instance of verb created by Verb's CLI for this file
170
+
// "app" is an instance of verb created by Verb's CLI for this file
173
171
};
174
172
```
175
173
@@ -429,4 +427,4 @@ Released under the [MIT license](https://github.com/verbose/verb/blob/master/LIC
429
427
430
428
***
431
429
432
-
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.1.28, on July 29, 2016._
430
+
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.1.28, on July 29, 2016._
0 commit comments