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

md-toc-generator

v2.0.0

Published

> Creates and updates tables of content in your markdown files.

Downloads

710

Readme

md-toc-generator

Creates and updates tables of content in your markdown files.

  1. Usage
  2. License

Usage

Install the package globally or as a local dependency:

# npm install md-toc-generator
# npm install --global md-toc-generator
# yarn global add md-toc-generator
yarn add md-toc-generator

Add a placeholder to files that you want to create ToC for:

[//]: # "BEGIN_TOC"
[//]: # "END_TOC"

Then call the script:

# adds/updates ToC README.md in current directory
md-toc-generator

# adds/updates ToC wherever you point it to
md-toc-generator --paths <PATH_TO_MD_FILE>

If you want to lint your markdown files to see if the ToC is up to date, but without changing anything, use the --ci flag (example usage in the GitHub actions of this project).

md-toc-generator --ci

If you want to ensure that given markdown files have a toc, use the --placeholder-required option.

License

See LICENSE file.