readme.md

Auto Table of Content

I believe that every article on web should have a table of content.

This userscript is not production-ready yet. There's many improvement points. See TODO list.

Demo

TOC on Github

More:

• Medium
• Wikipedia
• Wikipedia custom theme with the awesome Stylish theme WikiTex

How to use

Install

• Choose a userscript engine for your favorist browser:

  • Greasemonkey: Firefox
  • Tampermonkey: Chrome, Firefox, Opera
  • ViolentMonkey: Opera, Chrome

• Install script via this link.

Usage

• Open a Github, Wikipedia or Medium article, the TOC should be opened automatically after page is loaded. For example, try with this page:

• TOC can be toggle using the shortcut key Alt+q.

Show TOC on Firefox Markdown Previewer

---

This feature only works properly on Firefox with Markdown Previewer as of now. See demo

• Open about:config.
• Look for greasemonkey.fileIsGreaseable, set to true.
• Restart Firefox.
• Try with any local Markdown file.

License

MIT