0.1.4 • Published 10 years ago

gulp-doctoc v0.1.4

Weekly downloads
140
License
MIT
Repository
github
Last release
10 years ago

gulp-doctoc

Inject a table of contents into your markdown files.

Install

Install with npm

npm install --save-dev gulp-doctoc

Usage

var toc    = require('gulp-doctoc'),
    marked = require('gulp-marked');

gulp.task('markdown', function(){

  gulp.src('./**/*.md')
    .pipe(toc())
    .pipe(marked())
    .pipe(gulp.dest('./public/'));

});

By default, doctoc puts the TOC at the top of the file. To place it somewhere else, add:

<!-- START doctoc -->
<!-- END doctoc -->

Custom title, depth, mode and notitle options are also accepted

    // ...
    .pipe(toc({
      title: "Table des matières",
      depth: 3,
      mode: "bitbucket.org",
      notitle: true
    }))
    // ...

Thanks

Thanks to @thlorenz for doctoc. He did all the hard work.

License

MIT (same as doctoc)

0.1.4

10 years ago

0.1.3

10 years ago

0.1.2

10 years ago

0.1.1

10 years ago

0.1.0

10 years ago