Gulp plugin for markdown-toc. Generate a markdown table of contents for one or more markdown files, and an optional index for multiple files.
npm install gulp-markdown-toc> Gulp plugin for markdown-toc. Generate a markdown table of contents for one or more markdown files, and an optional index for multiple files.
Install with npm:
``sh`
$ npm install --save gulp-markdown-toc
`js
var gulp = require('gulp');
var toc = require('gulp-markdown-toc');
gulp.task('toc', function() {
return gulp.src('*.md')
.pipe(toc())
.pipe(gulp.dest('.'));
});
`
Heads up!
Add the following to markdown file where you want a Table of Contents to be injected:
`
In addition to the following plugin options, all markdown-toc options are supported as well. See that library for additional details.
Type: {Boolean|String|Function}
Default: undefined
Generate a Table of Contents index file. _If options.index is left undefined, an index file will not be generated._
`jstoc.md
// generates a file named
toc({index: true})
// specify the name of the index file
toc({index: 'foo.md'})
// customize the destination and file path of the index file
toc({
index: function(file) {
file.basename = 'whatever.md';
return 'blah';
}
})
`
Type: {Function}
Default: undefined
Filter the files to be included in the TOC index.
`js`
toc({
filter: function(file) {
return file.relative !== 'foo.md';
}
})
Type: {Function}
Default: undefined
Pass a compare function for sorting the files to be included in the TOC index.
`js`
toc({
sort: function(fileA, fileB) {
// fileA and fileB are vinyl files
return fileA.relative < fileB.relative;
}
})
Type: {Function}
Default: undefined
Customize heading names.
`js`
toc({
headingName: function(name) {
// do stuff to name
return name;
}
})
Type: {Function}
Default: undefined
Customize heading links.
`js`
toc({
headingLink: function(link) {
// do stuff to link
return link;
}
})
* gulp-format-md: Gulp plugin for beautifying markdown using pretty-remarkable. | homepage
* markdown-toc: Generate a markdown TOC (table of contents) with Remarkable. | homepage with Remarkable.")
* remarkable: Markdown parser, done right. 100% Commonmark support, extensions, syntax plugins, high speed - all in… more | homepage
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.
_(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:
`sh`
$ npm install -g verbose/verb#dev verb-generate-readme && verb
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:
`sh``
$ npm install && 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.6.0, on July 08, 2017._