Security News
The Push to Ban Ransom Payments Is Gaining Momentum
Ransomware costs victims an estimated $30 billion per year and has gotten so out of control that global support for banning payments is gaining momentum.
verb
Advanced tools
Readme
Documentation generator for GitHub projects. Extremely powerful, easy to use, can generate anything from API docs to a readme, for projects big or small.
Verb is the most powerful, extensible and easy-to-use documentation generator for node.js.
Install with npm
npm i verb --save-dev
var verb = require('verb');
<!-- toc -->
to any document.{%= include() %}
helperdocs/
directory with the {%= docs() %}
helpercwd
to the helper: example: {%= docs("foo", {cwd: ''}) %}
(WIP)
Verb's API is organized into the following categories:
(WIP)
Methods:
.create
.loader
.load
.engine
.helper
.helpers
.asyncHelper
.asyncHelpers
.render
Verb exposes entire API from template. See the [template docs] the full API.
Transforms
Run immediately during init. Used to extend or modify the this
object.
verb.transform('engine', function() {
this.engine('md', require('engine-lodash'));
});
Application Settings
Set arbitrary values on
verb.cache
:
.set
.get
.del
See the [config-cache docs] the full API.
Options
Set and get values from
verb.options
:
.option
.enable
.enabled
.disable
.disabled
.disabled
See the [option-cache docs] the full API.
(WIP)
Set and get values from
verb.cache.data
.data
Verb exposes entire API from plasma. See the [plasma docs] the full API.
(WIP)
Verb exposes the entire [en-route] API. See the [en-route docs] the full API.
(WIP)
Glob patterns or filepaths to source files.
Params
glob
{String|Array}: Glob patterns or file paths to source files.options
{Object}: Options or locals to merge into the context and/or pass to src
pluginsExample
verb.src('src/*.hbs', {layout: 'default'})
Specify a destination for processed files.
Params
dest
{String|Function}: File path or rename function.options
{Object}: Options and locals to pass to dest
pluginsExample
verb.dest('dist')
Copy a glob
of files to the specified dest
.
Params
glob
{String|Array}dest
{String|Function}returns
{Stream}: Stream, to continue processing if necessary.Example
verb.task('assets', function() {
verb.copy('assets/**', 'dist');
});
Define a Verb task.
Params
name
{String}: Task namefn
{Function}Example
verb.task('docs', function() {
verb.src(['.verb.md', 'docs/*.md'])
.pipe(verb.dest('./'));
});
Get a view collection by it's singular or plural name (e.g. "page" or "pages").
returns
{String} name
: Singular name of the collection to getExample
var collection = verb.getCollection('pages');
// gets the `pages` collection
//=> {a: {}, b: {}, ...}
Display a visual representation of the difference between two objects or strings.
Params
a
{Object|String}b
{Object|String}methodName
{String}: Optionally pass a jsdiffmethod name to use. The default is diffJson
Example
var doc = verb.views.docs['foo.md'];
verb.render(doc, function(err, content) {
verb.diff(doc.orig, content);
});
Re-run the specified task(s) when a file changes.
Params
glob
{String|Array}: Filepaths or glob patterns.fn
{Function}: Task(s) to watch.Example
verb.task('watch', function() {
verb.watch('docs/*.md', ['docs']);
});
It's magical and smells like chocolate. If that's not enough for you, it's also the most powerful and easy-to-use documentation generator for node.js. And it's magical.
Install dev dependencies:
npm i -d && npm test
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue
v0.4.0
: Verb now requires verb-clito run. See the getting started section for details.async115
Copyright (c) 2014-2015 Jon Schlinkert Released under the MIT license.
This file was generated by verb-cli on async117.
FAQs
Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used on hundreds of projects of all sizes to generate everything from API docs to readmes.
We found that verb demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ransomware costs victims an estimated $30 billion per year and has gotten so out of control that global support for banning payments is gaining momentum.
Application Security
New SEC disclosure rules aim to enforce timely cyber incident reporting, but fear of job loss and inadequate resources lead to significant underreporting.
Security News
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).