JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 161628
  • Score
    100M100P100Q160729F
  • License MIT

Generates TOC for markdown files of local git repo.

Package Exports

  • doctoc
  • doctoc/lib/file
  • doctoc/lib/transform

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (doctoc) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

DocToc build status

Generates table of contents for markdown files inside local git repository. Links are compatible with anchors generated by github or bitbucket via a command line flag.

Table of Contents generated with DocToc

Installation

npm install -g doctoc

Usage

Adding toc to all files in a directory and sub directories

Go into the directory that contains you local git project and type:

doctoc .

This will update all markdown files in the current directory and all its subdirectories with a table of content that will point at the anchors generated by the github markdown parser.

Adding toc to a single file

If you want to convert only a specific file, do:

doctoc /path/to/file

Example

doctoc README.md

In order to add a table of contents whose links are compatible with anchors generated by bitbucket, supply a --bitbucket flag to doctoc.

doctoc README.md --bitbucket