https://github.com/no5ix/auto-toc

A userscript that adds a table of contents to any website. 一个自动生成网站目录大纲的油猴脚本
https://github.com/no5ix/auto-toc

tampermonkey-script tampermonkey-userscript toc toc-generator userscript violentmonkey-script violentmonkey-userscript

Last synced: 3 months ago
JSON representation

A userscript that adds a table of contents to any website. 一个自动生成网站目录大纲的油猴脚本

• Host: GitHub
• URL: https://github.com/no5ix/auto-toc
• Owner: no5ix
• License: gpl-3.0
• Created: 2022-08-25T14:16:44.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-01-16T11:54:01.000Z (10 months ago)
• Last Synced: 2024-07-10T18:17:38.935Z (4 months ago)
• Topics: tampermonkey-script, tampermonkey-userscript, toc, toc-generator, userscript, violentmonkey-script, violentmonkey-userscript
• Language: JavaScript
• Homepage: https://greasyfork.org/en/scripts/458022-auto-toc?locale_override=1
• Size: 5.74 MB
• Stars: 25
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# auto-toc

Displays a table of contents for any website, making it easier to read and navigate long articles, documentations, and online books.

Generate TOC(table of contents) for any website. 可以为任何网站生成TOC网站目录大纲.

# 高级技巧Advanced Skills 

- Drag the `TOC drag bar`(that three dots) to move `auto-toc`.

- 拖动 TOC拖动栏 来移动 `auto-toc`

- Click on the `TOC drag bar`(that three dots) to toggle headings text wrap.

- 单击 TOC拖动栏(三个圆点) 可以切换标题折行

- Double-click on the `TOC drag bar`(that three dots) to automatically dim the TOC..

- 双击 TOC拖动栏(三个圆点) 可以自动折叠 TOC

![](auto_toc_demo_image.jpg)

# Features

- Work properly on any website that conforms to the HTML standard and uses HTML heading tags properly (e.g. Wikipedia.com). 

- Accurate article and heading detection

- A clean user interface

- Highlight current heading

- Click to jump to headings

- Drag the panel to your preferred position

- Only runs when you actually use it

- Dark mode, automatically

- 6 heading levels

- Expand all headings to a specific level

- Support HTML label:

  - `H1`, `H2`, `H3`, `H4`, `H5`, `H6`

  - ``

  - ``

- Anti-Google-Redirect

- Anti-Jumping-Warnings

- Hide-Zhihu-Top-Bar-When-Scrolling-Down

- Touch-Fish(Shrink IMG)


# 捐赠

捐赠! 让作者更有动力给 auto-toc 加新功能! ^_^

- 微信

  - ![微信](https://github.com/no5ix/no5ix.github.io/blob/source/source/img/sux/donate_wechat.png)

- 支付宝

  - ![支付宝](https://github.com/no5ix/no5ix.github.io/blob/source/source/img/sux/donate_alipay.png)

# Installation & Usage

- English: https://greasyfork.org/en/scripts/458022-auto-toc?locale_override=1

- 中文: https://greasyfork.org/zh-CN/scripts/458022-auto-toc?locale_override=1

By default, it is not open. You need to go to the plug-in menu to open the switch for the website that wants to open the toc. The plug-in will remember this switch, and the toc will be generated automatically according to the switch when you open the website the next time.

可以为任何网站生成TOC网站目录大纲, 默认是不打开的, 需要去插件菜单里为想要打开 toc 的网站开启开关, 插件会记住这个开关, 下回再打开这个网站会自动根据开关来生成 toc 与否.