/userscript-auto-toc

Auto create a fixed table of content on any site using Greasemonkey or Tampermonkey

Primary LanguageJavaScript

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

TOC on Github

More:

How to use

Install

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