Skip to content

Extract headings from Markdown documents to create a Table of Contents

Notifications You must be signed in to change notification settings

richard-reece/md-toc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Extract headings from Markdown documents to create a Table of Contents

Usage:

md-toc <filename> [max header level]")

This was written as an excuse to learn some Rust, with a purpose (I wanted to be able to do this thing).

To make it work, you'll need to cargo make build and then the above program appears in ./target/debug/md-toc.

To use the web version, after cargo make build run cargo make serve (or use any similar tool like python3 -m http.server in the directory containing index.html).

License

Copyright (C) 2019 by Reece P/L richard.jones@reece.com.au

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

About

Extract headings from Markdown documents to create a Table of Contents

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published