Nuclear Pumpkin Mayhem

    gulp-markdown-toc

    1.1.0 • Public • Published

    gulp-markdown-toc NPM version NPM monthly downloads NPM total downloads Linux Build Status

    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

    Install with npm:

    $ npm install --save gulp-markdown-toc

    Usage

    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:

    <!-- toc -->
    

    Options

    In addition to the following plugin options, all markdown-toc options are supported as well. See that library for additional details.

    options.index

    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.

    // generates a file named `toc.md`
    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';
      }
    })

    options.filterFiles

    Type: {Function}

    Default: undefined

    Filter the files to be included in the TOC index.

    toc({
      filter: function(file) {
        return file.relative !== 'foo.md';
      }
    })

    options.sortFiles

    Type: {Function}

    Default: undefined

    Pass a compare function for sorting the files to be included in the TOC index.

    toc({
      sort: function(fileA, fileB) {
        // fileA and fileB are vinyl files
        return fileA.relative < fileB.relative;
      }
    })

    options.headingName

    ## [headingName](#headingLink)
    

    Type: {Function}

    Default: undefined

    Customize heading names.

    toc({
      headingName: function(name) {
        // do stuff to name
        return name;
      }
    })

    options.headingLink

    ## [headingName](#headingLink)
    

    Type: {Function}

    Default: undefined

    Customize heading links.

    toc({
      headingLink: function(link) {
        // do stuff to link
        return link;
      }
    })

    About

    Related projects

    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.6.0, on July 08, 2017.

    Install

    npm i gulp-markdown-toc

    DownloadsWeekly Downloads

    166

    Version

    1.1.0

    License

    MIT

    Last publish

    Collaborators

    • jonschlinkert