npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

gulp-markdown-toc

v1.1.0

Published

Gulp plugin for markdown-toc. Generate a markdown table of contents for one or more markdown files, and an optional index for multiple files.

Downloads

1,581

Readme

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.