UNPKG

verb

Version:

Verb makes it easy to build project documentation using simple markdown templates, with zero configuration required.

github.com/assemble/verb

assemble/verb

32 lines (13 loc) • 1.05 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
## Ease of Use > Verb loves users Verb's number one priorty is ease-of use. For new users **zero configuration** is required to get started. Once Verb is installed, simply enter `docs` in command line, and you're off and running. For more experienced users, Verb offers _more than 50 template tags and filters, includes and partial caching, comment parsing, YAML Front Matter (or Coffee Front Matter!), plugins, mixins, tons of helpful JavaScript and Node.js utilites_, and lots more. ## API > Verb loves developers Verb has an extensive API and tools for building plugins, custom tags and filters, or extending Verb in other ways. Once installed globally, running `verb` at the command line will read any files in the `./docs` directory of your project. This is easily customized will automatically gather information from your project's package.json and git repository, then Use the CLI for to build , or required as a node lib. Verb keeps things simple by using well-defined conventions Verbs advantage is that it comes with