Skip to content

README.md

Latest commit

 

History

History
57 lines (37 loc) · 819 Bytes

README.md

File metadata and controls

57 lines (37 loc) · 819 Bytes

mdtoc

Simple table of contents generator for GitHub flavored markdown files.

Installation

Clone the repository

git clone https://github.com/doomnuggets/mdtoc.git

Move your horses

cd mdtoc

Compile from source

If you'd like to call mdtoc from anywhere on your system use:

make install

Or, if you only want to test it out for now:

make

Generating a table of contents

You can either pass the file to read from like so:

mdtoc file.md

Or you can pipe to mdtoc:

cat ~/file.md | mdtoc

Example

doom@nuggets:~/code/c/mdtoc: ./mdtoc README.md
+ [mdtoc](#mdtoc)
  + [Installation](#installation)
  + [Generating a table of contents](#generating-a-table-of-contents)
    + [Example](#example)