yankeexe/toc-md

Generate/inject "Table of Contents" for markdown files.

toc-md

Generate or inject "Table of Contents" for markdown file.

Contents

• toc-md
  • Installation
    • Install toc-md
    • Verify installation
  • Usage

Installation

Install toc-md

1. Download the zip from releases

2. unzip the tar file

   $ tar -xzf toc

3. Copy the binary to bin directory.

   $ sudo cp toc /usr/local/bin

Verify installation

Run toc to see the help message.

$ toc

Usage

Generate table of contents

$ toc gen "README.md"

Inject table of contents to the file.

$ toc gen "README.md" -i