SimpleTOC – Table of Contents Block

Description

En Gutenberg, añade un bloque y busca «SimpleTOC» o simplemente «TOC». Por favor, guarda tu contenido antes de usar el bloque. Funciona analizando el contenido de la entrada y recuperando los bloques de encabezado, y crea un nuevo bloque dinámico con una lista de enlaces a los encabezados.

Hide the headline “Table of Contents” and set a maximum display depth in the blocks’ sidebar configuration. Add the CSS class “simpletoc-hidden” to a heading block to remove that specific heading from the generated TOC.

Características

  • No javascript or css added.
  • Designed for Gutenberg.
  • Compatible with AMP plugins.
  • Minimal and valid HTML output.
  • Inherits the style of your theme.
  • Support for column block layouts.
  • Control the maximum depth of the headings.
  • Choose between an ordered and unordered html list.
  • SEO friendly: Disable the h2 heading of the TOC block and add your own.
  • Comes with English, French, Spanish, German, and Brazilian Portuguese translations.
  • Works with non-latin texts. Tested with Japanese and Arabic.
  • Finds headlines in groups and reusable blocks. And in groups within reusable blocks.
  • Rank Math support.

Credits

Este plugin se ha bifurcado de https://github.com/pdewouters/gutentoc por pdewouters y usa el código de https://github.com/shazahm1/Easy-Table-of-Contents por shazahm1

Many thanks to Tom J Nowell https://tomjn.com and and Sally CJ who both helped me a lot with my questions over at wordpress.stackexchange.com

Screenshots

  • SimpleTOC block in Gutenberg editor.
  • SimpleTOC in the post.
  • Simple but powerful. Customize each TOC as you like.
  • Control the maximum depth of the headings.

Blocks

This plugin provides 1 block.

  • SimpleTOC

Installation

SimpleTOC se puede encontrar e instalar a través del menú «Plugins» dentro del escritorio de WordPress (Plugins -> Añadir nuevo). Alternativamente, se puede descargar desde WordPress.org e instalar manualmente…

En Gutenberg, añade un bloque y busca «SimpleTOC» o simplemente «TOC». Por favor, guarda tu contenido antes de usar el bloque.

FAQ

Why did you do this?

Because I needed a simple plugin to do this job and decided to do it on his own. I believe that a Table of Contents does not need Javascript and additional css. Furthermore the plugin should work out-of-the-box without any configuration.

How do I change the TOC heading ‘Table of contents’ to some other words?

Hide the headline in the sidebar options of SimpleTOC and add your own heading.

How do I add SimpleTOC to all articles automatically?

I don’t see an easy solution at the moment. SimpleTOC is only a block that can be placed in your post. If there would be a plugin that adds blocks to every post then this would be the solution. I think this should be another separate plug-in to keep the code of SimpleTOC clean and … well, simple. Maybe someone knows of a plug-in that adds blocks automatically to all posts with some parameters and settings? What about site editing in WordPress? I think the core team is working on something like that. I will keep this post open. If I have gained more knowledge how to solve this I will add this feature.

How do I add a background color to SimpleTOC?

SimpleTOC is simple. It will never load JavaScript or CSS. But you can add custom CSS yourself to your theme:

.simpletoc {
    padding: 1em 2em;
    background: #bada55;
}

If you want to add a color including the headline, add a custom css class to the SimpleTOC block. Name it “toctoc” or something like that.

.toctoc {
    padding: 1em 1em;
    background: #bada55;
}

If you use that CSS it will add a colored background to the whole TOC including the heading.

Reviews

28 de Febrero, 2021
Simple, effective, and very well supported. Other toc plugins seem bloated with features and code that really complicates something that should simply fit right into your theme styles without adjustment. This plug-in is perfect for a cohesive fit into your site as it inherits your theme styles. It’s also compatible with the rank math SEO plug-in. Supports reusable blocks too! Finds the headers buried in groups and saved as reusable blocks. Excellent feature! The best feature though is the outstanding support from Marc the developer. He responds and communicates well to all requests. That means a lot when you stumble upon a needed feature or request an improvement appropriate to the simplicity designed into this plug-in. Five stars should be ten for this plug-in! Kudos Marc for all you do!
25 de Febrero, 2021
A simple and effective plugin that just works. You can't go wrong. Plus the author provides exceptional support.
25 de Febrero, 2021
Very simple to use - even for a newbie like myself. Add 'SimpleTOC as a block to your WP page, and assign the headings on the page as you go. SimpleTOC pulls those headings into a neat Table of Contents, which hyperlinks and snaps to the heading section on the page. It also pulls in the styles from your theme, keeping a nice, consistent look. Excellent and speedy support from the dev too when an element of the plugin wasn't working on my site. Was all fixed within the hour! Stop looking at alternatives and install this plugin.
Read all 19 reviews

Contributors & Developers

“SimpleTOC – Table of Contents Block” is open source software. The following people have contributed to this plugin.

Contributors

“SimpleTOC – Table of Contents Block” has been translated into 8 locales. Thank you to the translators for their contributions.

Translate “SimpleTOC – Table of Contents Block” into your language.

Interested in development?

Browse the code, check out the SVN repository, or subscribe to the development log by RSS.

Changelog

4.5

  • Feature: Add the css class “smooth-scroll” to the links. This enables smooth scrolling in themes like GeneratePress.

4.4.9.2

  • Refactoring: Better TOC generation with less HTML validation errors.

4.4.9

  • Feature: Support for headlines in reusable blocks.

4.4.8

  • Feature: Added option to toggle absolute urls.

4.4.7

  • Fix: Heading ids won’t be added to all posts anymore.
  • Fix: Headings with attributes like align-center will now appear in your TOC.
  • Feature: Added option to replace ul tag with ol tag. This will add decimal numbers to each heading in the TOC.
  • Feature: Works in nested blockes. This means support for column block layouts.

4.3

  • Feature: Support for non-latin headlines. SimpleTOC now uses a character block list rather than an allow list.
  • Feature: Add the CSS class “simpletoc-hidden” to the heading block to remove it from the Table of Contents.

4.1.1

  • Feature: Experimental support for Arabic Text.

4.0

  • Feature: Added option to set maximum level of the headings.

3.9

  • Added Brazilian Portuguese translations to the translations. Thanks Ralden Souza!

3.5

  • Added support for Rank Math plugin.