This is a small node script to preprocess and create table of contents for markdown documents. It examines the document you pass to it, creates a table of contents based on your titles, and inserts it instead of every line that contains '@@TOC@@'
npm install md-toc-filter
|1||downloads in the last day|
|1||downloads in the last week|
|3||downloads in the last month|
|Version||0.9.0 last updated 2 years ago|
|Keywords||table of contents, toc, contents|
Table of Contents Generator
Small and simple README.md preprocessor for creating table of contents.
Say you've got a README.md file with lots of information, and you want to create a table of contents with reference links
This script will help you to do so. It extracts information of titles in a given file, and inserts a formatted table of contents in the position, specified by "@@TOC@@" line.
node toc.js README.md > NEW_README.md
# Foo Great Project Hey, this is my project ## Contents @@TOC@@ ## About Some info about it ## Authors My picture here
Will be transformed to
# Foo Great Project Hey, this is my project ## Contents - [Foo Great Project](#foo-great-project) - [Contents](#contents) - [About](#about) - [Authors](#authors) ## About Some info about it ## Authors My picture here
After the preprocessing you're free to modify the result as you wish. For example, it makes sense to remove reference to table of contents from table of contents
The script doesn't support underlined titles like this
My Title ========
Use sharps instead
# My Title