Light

atheiman / gfm-toc Goto Github PK

View Code? Open in Web Editor NEW

3.0 2.0 5.0 19 KB

Add table of contents to your markdown files

Ruby 100.00%

gfm-toc's Introduction

gfm-toc

Ruby utility to generate a markdown formatted table of contents from GitHub flavored markdown files.

Usage

The utility is all contained in a single file, so you can just grab the file with curl:

# download the utility
curl -O https://raw.githubusercontent.com/atheiman/gfm-toc/master/gfm-toc
# make it executable
chmod 764 gfm-toc
# show the help
./gfm-toc -h
# update your markdown file with a %TOC% where you want the TOC generated
./gfm-toc README.md

Place %TOC% in your markdown file whereever makes sense to you. Any headers identified with a # below the %TOC% are added into the generated table of contents.

See INPUT.md and OUTPUT.md for a thorough example.

Run the utility with the -h,--help option to see the full option list.

It should work with any crazy header you can come up with.

gfm-toc's People

Contributors

Stargazers

Watchers

Forkers

ast-interview yshiyi jtwhite79 kougazhang dgasl

gfm-toc's Issues

max header depth specified in toc tag

Allow specifying the max header depth to be included in the generated table of contents by passing a parameter: %TOC:2% will only inlude headers identified with # and ##

ignore lines beginning with hash in code blocks

ignore header looking lines that are in code blocks (indented or fenced). I think indented #s are already ignored...

update generated toc

Allow utility to be run on the same file consecutively to get the same result (i.e. update a file and run the utility again to update the generated TOC)

Probably want to just wrap the generated TOC with a comment that say  and , then just update the contents between the comments every time the utility is run.

run against multiple files

Run utility on a directory, matching any .md, .mdown, and .markdown files

if toc not in file, print to stdout

If %TOC% is not in the file, the generated TOC should just be printed to stdout

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.