Verb plugin that adds middleware for creating and injecting a table of contents into a markdown document.
npm install verb-toc> Verb plugin that adds middleware for creating and injecting a table of contents into a markdown document.
- Docs
- toc event
- verb config
- verb CLI
* toc
* Save to project's verb config
* Save to global verb config
- About
_(TOC generated by verb using markdown-toc)_
Install with npm:
``sh`
$ npm install --save verb-toc
HEADS UP!!!
This only works with Verb v0.9.0 and higher! (also works with assemble).
`js`
var toc = require('verb-toc');
Basic example
In your verbfile.js:
`js`
module.exports = function(verb) {
verb.extendWith(require('verb-toc'));
// do stuff, render templates, write files
};
Add a HTML comment to any markdown document where you want a table of contents to be injected. For the TOC middleware to run, you'll need to either call the postLayout and preWrite middleware handlers yourself, or follow the example below.
*
Middleware
The main export is a function that when invoked with an instance of verb will automatically register two middleware functions:
* a .postLayout (createToc) middleware that creates the table of contents after a layout has been applied.preWrite
* a (injectToc) middleware that injects the table of contents back into the document after all other plugins have run.
Both middleware functions are also exposed as properties on module.exports, so you can try other stages if you want. Be warned that there are pros and cons to most middleware stages, in my own experience these stages work really well and seem to result in the fewest unwanted side-effects.
If you want to completely customize how the TOC is injected, you can listen for the toc event.
Params
* file Exposes the vinyl file being rendered
Example
`jsfile.contents
verb.on('toc', function(file, next) {
// do stuff to , then call next`
next();
});
Register the middleware
In your verbfile.js:
`js.renderFile
module.exports = function(verb) {
verb.extendWith(require('verb-toc'));
// use any template engine, but you must call
// (below) to trigger the necessary middleware stages
verb.engine('*', require('engine-base'));
// example task
verb.task('docs', function(cb) {
return verb.src('docs/*.md', { cwd: __dirname })
.pipe(app.renderFile('*'))
.pipe(verb.dest('dist'));
});
verb.task('default', ['docs']);
};
`
_(In v0.9.0 and higher, verbfiles that export a function are recognized by verb as "generators", allowing them to be locally or globally installed, and composed with other generators. You can alternatively export an instance of verb, but it's not as fun...)_
Enable or disable Table of Contents rendering, or pass options on the verb config object in package.json.
Example
`json`
{
"name": "my-project",
"verb": {
"toc": true
}
}
Disable or enable TOC rendering from the command line.
Enable
Enable the table of contents for the current build:
`sh`
$ verb --toc
Disable
Disable the table of contents for the current build:
`sh`
$ verb --toc=false
Persist TOC settings for a project to the verb config object in package.json:
Enable
Enable the table of contents for a project:
`sh`
$ verb --config=toc
Disable
Disable the table of contents for a project:
`sh`
$ verb --config=toc:false
Persist TOC settings to be used as global:
Enable
Enable the table of contents for a project:
`sh`
$ verb --global=tocor
$ verb -g=toc
Disable
Disable the table of contents for a project:
`sh`
$ verb --global=toc:falseor
$ verb -g=toc:false
* markdown-toc: Generate a markdown TOC (table of contents) with Remarkable. | homepage with Remarkable.")
* verb: Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used… more | homepage
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
_(This document was generated by verb-generate-readme (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)_
To generate the readme and API documentation with verb:
`sh`
$ npm install -g verb verb-generate-readme && verb
Install dev dependencies:
`sh``
$ npm install -d && npm test
Jon Schlinkert
* github/jonschlinkert
* twitter/jonschlinkert
Copyright © 2017, Jon Schlinkert.
Released under the MIT license.
*
_This file was generated by verb-generate-readme, v0.2.1, on January 02, 2017._