Skip to content

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

License

Notifications You must be signed in to change notification settings

yankeexe/toc-md

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

toc-md

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

Contents

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