FreePhoenix888 / generate-table-of-contents-for-markdown

Generates table of contents for markdown

Table Of Contents

• Table Of Contents
• Quick Start
• Library

Quick Start

• Add the following to your README.md

  <!-- TABLE_OF_CONTENTS_START -->
  <!-- TABLE_OF_CONTENTS_END -->

• Run this javascript code

  import {readFileSync, writeFileSync} from 'fs';
  import {generateUsageWaysOfNpmCliApps} from '@freephoenix888/generate-table-of-contents-for-markdown';
  
  const generatedUsageWays = generateTableOfContentsForMarkdown({
    markdownFilePath,
    output: {
      writeMode: 'replace-placeholder',
      placeholder: {
        start: `<!-- TABLE_OF_CONTENTS_START -->`,
        end: `<!-- TABLE_OF_CONTENTS_END -->`,
      },
      filePath: 'README.md'
    }
  });
  console.log(generatedUsageWays)

Library

See Documentation for examples and API