Description
table of contents/list of contents is a powerful yet user-friendly plugin that automatically generates a table of contents for your posts, pages, and custom post types by parsing the contents for headers. It supports multiple post editors and integrates seamlessly with popular plugins.
Features
- Automatic TOC Generation: Parses your content for headers and generates a table of contents.
- Pagination Support: Works with the
<!--nextpage-->
tag. - Page Builder Compatibility: Works with Classic Editor, Gutenberg, Divi, Elementor, WPBakery Page Builder, and Visual Composer.
- Configurable TOC Insertion: Optionally enable for pages and/or posts, and custom post types. The TOC can be auto-inserted into the content.
- Display Options: Multiple options to configure when and where to insert the TOC.
- Appearance Customization: Several built-in themes and customization options for border, background, and link colors.
- Counter Bullet Formats: Choose from none, decimal, numeric, and roman.
- Hierarchical Display: Display the TOC hierarchically or flat.
- User Control: Optionally allow users to hide the TOC, with control over default visibility.
- Smooth Scrolling: Supports smooth scrolling for better navigation.
- Selective Enabling: Enable or disable the TOC on a per-post basis.
- Heading Selection: Choose which headings to include in the TOC, with per-post configuration.
- Header Exclusion: Easily exclude headers globally or on a per-post basis.
- Widget Support: Use a widget to place the TOC in your theme’s sidebar, with options for sticky positioning and section highlighting.
- Developer Friendly: Many action hooks and filters are available. Pull requests are welcomed on GitHub.
- Advanced Options: Show TOC based on dynamic paragraph count, preserve line breaks, use TOC without anchor links, support custom taxonomy description, and add SiteNavigation Schema.
- Designs: Includes four design options, including a two-column layout.
License
This plugin is licensed under the GPLv2 or later.
Screenshots
Blocks
This plugin provides 1 block.
- Table of Contents
Installation
- Upload the plugin files to the
/wp-content/plugins/list-of-contents
directory, or install the plugin through the WordPress plugins screen directly. - Activate the plugin through the ‘Plugins’ screen in WordPress.
- Use the Settings->List of Contents screen to configure the plugin.
FAQ
-
Q: Can I disable the TOC for specific posts?
-
A: Yes, you can selectively enable or disable the TOC on a per-post basis.
-
Q: How can I customize the appearance of the TOC?
-
A: The plugin provides several built-in themes and customization options for the border, background, and link colors. You can select your preferred design in the settings.
-
Q: Does the plugin support page builders?
-
A: Yes, the plugin works with Classic Editor, Gutenberg, Divi, Elementor, WPBakery Page Builder, and Visual Composer.
-
A: Yes, you can use the provided widget to place the TOC in your theme’s sidebar. The widget supports sticky positioning and section highlighting.
Contributors & Developers
“List of Contents” is open source software. The following people have contributed to this plugin.
ContributorsTranslate “List of Contents” into your language.
Interested in development?
Browse the code, check out the SVN repository, or subscribe to the development log by RSS.
Changelog
1.0.5 (02-11-2024)
- Added toggle list contents feature on click of Heading text.
- Added option for Heading text field.
- Updated settings panel
1.0.4 (15-09-2024)
- Added Navigation to index on google search.
- Added Compatibility with classic editor.
1.0.3 (28-08-2024)
- Avoid blank headings.
- remove block, if no headings.
1.0.2
- Added a block for the list of contents.
- Resolved the pagination link issue nextpage.
1.0.0
- Initial release.