gulp-html-toc
v1.1.0
Published
Gulp plugin for html-toc, for generating a HTML table of contents.
Downloads
87
Maintainers
Readme
gulp-html-toc
Gulp plugin for html-toc, for generating a HTML table of contents.
Install
Install with npm:
$ npm install --save gulp-html-toc
Install with yarn:
$ yarn add gulp-html-toc
Usage
var toc = require('gulp-html-toc');
gulp.task('toc', function() {
return gulp.src('foo/*.html')
.pipe(toc())
.pipe(gulp.dest('bar'));
});
Options
options.id
Type: string
Default: #toc
(usage: <div id="toc"></div>
)
Specify the id for where the table of contents should be injected.
Example
toc({id: '#navigation'});
In your HTML, add the following:
<div id="navigation"></div>
options.anchors
Type: boolean
Default: undefined
Set to false
to disable anchors.
Example
toc({anchors: false});
options.anchorTemplate
Customize the template for creating anchors.
Type: function
Default
<a href="#${id}" name="${id}" class="anchor">
<span class="anchor-target" id="${id}"></span>
<span class="glyphicon glyphicon-link"></span>
</a>
Example
toc({
anchorTemplate: function(id) {
return `<a class="anchor" href="${id}" id="${id}"></a>`;
}
});
options.selectors
Heading selectors to use for generating the table of contents.
Type: string
Default: h1,h2
Example
Generate a table of contents for all headings h1-h4.
toc({selectors: 'h1,h2,h3,h4'});
About
Related projects
- gulp-htmlmin: gulp plugin to minify HTML. | homepage
- gulp-prettify: Prettify, format, beautify HTML. | homepage
- html-toc: Generate a HTML table of contents using cheerio. | homepage
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Please read the contributing guide for advice on opening issues, pull requests, and coding standards.
Building docs
(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)
To generate the readme, run the following command:
$ npm install -g verbose/verb#dev verb-generate-readme && verb
Running tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
$ npm install && npm test
Author
Jon Schlinkert
License
Copyright © 2017, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.5.0, on April 17, 2017.