Skip to content

πŸ“œ Generates table of contents for markdown files inside local git repository. Links are compatible with anchors generated by github or other sites.

License

Notifications You must be signed in to change notification settings

technote-space/doctoc

This branch is 350 commits ahead of, 43 commits behind thlorenz/doctoc:master.

Repository files navigation

DocToc

npm version CI Status codecov CodeFactor License: MIT

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

Table of Contents

Details

Install

yarn add @technote-space/doctoc

Example

import {readFileSync} from 'fs';
import {findMarkdownFiles, transform} from '@technote-space/doctoc';

findMarkdownFiles(__dirname);

transform(readFileSync('README.md', {
  // mode: 'github.com', // github.com | bitbucket.org | gitlab.com | nodejs.org | ghost.org (default: github.com)
  // maxHeaderLevel: 2, // default: 4
  // title: '**Table of Contents**',
  // isNotitle: true,
  // isFolding: true,
  // entryPrefix: '*',
  // processAll: true,
  // updateOnly: true,
  // openingComment: '<!-- toc -->',
  // closingComment: '<!-- tocstop --> ',
  // checkOpeningComments: ['<!-- toc '],
  // checkClosingComments: ['<!-- tocstop '],
  // checkSkipComments: ['<!-- toc skip '],
  // isCustomMode: false,
  // customTemplate: '<p align="center">${ITEMS}</p>',
  // itemTemplate: '<a href="${LINK}">${TEXT}</a>',
  // separator: '<span>|</span>',
  // footer: '',
}));

Author

GitHub (Technote)
Blog

About

πŸ“œ Generates table of contents for markdown files inside local git repository. Links are compatible with anchors generated by github or other sites.

Resources

License

Code of conduct

Stars

Watchers

Forks

Sponsor this project

Languages

  • TypeScript 99.2%
  • JavaScript 0.8%