☰

GitHub Table of Contents

A userscript that adds a table of contents to readme & wiki pages

Cómo instalar

Tendrás que instalar una extensión para tu navegador como Tampermonkey, Greasemonkey o Violentmonkey si quieres utilizar este script.

You will need to install an extension such as Tampermonkey to install this script.

Tendrás que instalar una extensión como Tampermonkey o Violentmonkey para instalar este script.

Necesitarás instalar una extensión como Tampermonkey o Userscripts para instalar este script.

Tendrás que instalar una extensión como Tampermonkey antes de poder instalar este script.

Necesitarás instalar una extensión para administrar scripts de usuario si quieres instalar este script.

(Ya tengo un administrador de scripts de usuario, déjame instalarlo)

Cómo instalar

Tendrás que instalar una extensión como Stylus antes de poder instalar este script.

Tendrás que instalar una extensión como Stylus antes de poder instalar este script.

Tendrás que instalar una extensión como Stylus antes de poder instalar este script.

Para poder instalar esto tendrás que instalar primero una extensión de estilos de usuario.

Para poder instalar esto tendrás que instalar primero una extensión de estilos de usuario.

Para poder instalar esto tendrás que instalar primero una extensión de estilos de usuario.

(Ya tengo un administrador de estilos de usuario, déjame instalarlo)

Autor
Mottie
Instalaciones diarias
1
Instalaciones totales
716
Calificaciones
19 0 1
Versión
2.1.6
Creado
29/3/2016
Actualizado
17/2/2024
Tamaño
16 KB
Licencia
MIT
Funciona en

A userscript that adds a table of contents to both readme and wiki pages.

  • NOTE: When updating to v2.0+, you may have to reset the popup (g + r) as the positioning method has changed.
  • A draggable popup window is automatically added when rendered markdown is detected; there must be at least three anchors before the TOC is created.
  • The TOC will refresh while switching between pages, and previewing markdown changes.
  • Move (drag-and-drop): Click and hold on the header to move the TOC window. If it gets moved and you can't get it back, use the keyboard shortcut to reset the position.
  • Toggle Window
    • Click on the header icon to toggle the window between the upper right corner and its last position.
    • Double-click on the header text to toggle the window.
    • Or, use the keyboard shortcut to toggle the view.
  • Toggle Entries
    • Each anchor within the rendered markdown will be included in the TOC window.
    • Click on the arrow next to the anchor link to toggle the sub-group.
    • Shift + Click on the arrow next to the anchor to toggle all same level items.
    • Some anchor link text may be truncated, hover over the link to see the full title.
  • To modify the "Table of Contents" text, open the userscript addon popup window and look for the "Set Table of Contents Title" setting.
  • Keyboard commands:
    • Press Esc to "hide" the TOC in the upper right corner.
    • Press g + t, within one second of each other, to toggle the TOC view.
    • Press g + r, within one second of each other, to reset the TOC position.
  • See the change log here.
  • Then test it on this page.

github-toc

Hosted with ♥ at GitHub