Automatic TOC creation

README.md

Your readme

Some text

Table Of Contents

• Your readme
• Table Of Contents
• Explanation
• Dependencies

Explanation

According to StackOverflow, this supposed to be comment in MarkDown:

[//]: # "some-text"

You put this text in your file where TOC should be:

[//]: # "start-toc"
[//]: # "end-toc"

So, script takes content before such comment, after it, and write TOC before them.

You could see RAW version of this file te see how this script works.

You could use mdtoc2, if your file contains non-ascii symbols. mdtoc2 will unescape these symbols.

Dependencies

Put gh-md-to to on of your PATH directory.

mdtoc

#!/bin/bash

cat README.md | grep start-toc --before-context 99999999 > temp.md
cat README.md | gh-md-toc - >> temp.md
echo >> temp.md
cat README.md | grep end-toc --after-context 99999999 >> temp.md
rm README.md
mv temp.md README.md

mdtoc2

#!/bin/bash

cat README.md | grep start-toc --before-context 99999999 > temp.md
cat README.md | gh-md-toc - > toc.md
printf '%b\n' "$(<toc.md)" >> temp.md
echo >> temp.md
cat README.md | grep end-toc --after-context 99999999 >> temp.md
rm README.md toc.md
mv temp.md README.md