Tocly Documentation

Overview

An automatic table of contents built from your headings, with smooth scrolling, the current section highlighted and a slim reading progress bar.

• Long articles become easy to scan
• Readers jump straight to the right section
• Reading progress bar keeps them reading

Best for: Blogs, guides and documentation

Installation

1. Download tocly-table-of-contents.zip from My account › My plugins or from your order email. Do not unzip it.
2. In WordPress, go to Plugins › Add New Plugin › Upload Plugin, choose the zip and click Install Now, then Activate.
3. Adjust it in Settings › Table of contents.

Requires WordPress 6.0+, PHP 7.4+. Works with any theme, block themes and page builders.

Features

• Automatic table of contents on the post types you choose (posts, pages, products…)
• H2, H3 and H4 levels, nested; shown only when a page has enough headings
• Placed after the introduction (before the first heading) or at the top; or anywhere with the `[tocly]` shortcode
• Anchors added to headings automatically (existing ids are kept); exclude a heading with the class "no-toc"
• Smooth scrolling with an offset for sticky headers, URL updated, focus moved for keyboard users
• Current section highlighted while reading
• Foldable (open or closed by default), optional numbering (1, 1.1, 1.2)
• Box or side-line style, your accent color
• Reading progress bar at the top of the screen, measured on the article itself
• Hide it on a single post from the editor sidebar
• Lightweight: no jQuery, no external service, no tracking; assets only on pages with a table of contents
• Translation-ready

Shortcodes

Paste a shortcode in any page, post, widget or page builder text block.

• [tocly]

Options of each shortcode are described in the Features above and in the plugin settings page.

For developers

Customize the plugin from your theme’s functions.php or a small plugin, without editing its files (your changes survive updates).

Filters

• tocly_enabled

add_filter( 'tocly_enabled', function ( $value ) {
	// Change $value here.
	return $value;
}, 10, 1 );

Updates

Updates are free. When a new version is out, it appears in Dashboard › Updates of your WordPress site and you can install it in one click, or turn on automatic updates in Plugins. This works for the zip downloaded from your Woo-Plugins account; older copies can be replaced by downloading the latest version from My plugins. See the changelog.

Frequently asked questions