Plugin Table of contents
TOCguide
The table of contents that reads with your reader.
TOCguide is a WordPress plugin that builds a table of contents from the headings in a post. The outline is in the first HTML. An optional Reading Guide adds section previews, read time, and study tools. No accounts, no tracking.
- Free download
- 1.6.15 Current release
- Server rendered
Screenshots
What it looks like
TOCguide block: outline from post headings
What you get
Everything in this build
Writers, shops, and agencies that publish long posts. Also hiring managers who want to see a small plugin I shipped.
- Gutenberg Table of Contents block with live editor preview
- [tocguide] shortcode for classic content and page builders
- Sticky and scroll-spy options
- Reading Guide and study tools (opt-in)
- Academic citations (APA, MLA, Chicago, Harvard, plain link)
- Optional ItemList JSON-LD
- Settings → TOCguide (design, a11y, auto-insert)
- Docs and support HTML
- Zero config. Insert the block; the outline builds itself
- Server-rendered HTML for SEO and screen readers
Show all 15 features Show fewer
- Accurate anchors with aria-current while you read
- Numbered or bulleted lists, five style presets
- Reading Guide adds previews, density bars, and read time
- Study tools add a progress bar, bookmark, and private notes
- Free forever. GPLv2 or later, no tracking
Take a look
See TOCguide for yourself
Open the live demo, or read how it is built.
Story
How it came together
-
Why I built it
Long posts need a jump list. Many plugins add extra blocks or hide the outline from search engines and screen readers.
-
What I did
I built a light plugin that reads headings and prints the list on the first page load. Reading Guide, citations, and study tools stay opt-in.
- Nothing phones home.
-
What you can use
A publisher can add a table of contents that is easy to read and easy to find. The plugin is free.
- Hire me if you want it tailored.
Under the hood
Stack, architecture, and handoff
Specs
-
Stack
- WordPress
- Gutenberg
- PHP
-
Languages
- PHP
- JavaScript
- SCSS
- CSS
- Shell
- Compatible WordPress 6.4+ (tested up to 7.1), PHP 7.4+
- License GPLv2 or later
- Release v1.6.15
- Updated November 17, 2026
- GitHub stars 2
- Topics accessibility, block-editor, gutenberg, gutenberg-block, php, roots-sage, seo, table-of-contents
- Repository matthummel-pa/tocguide (opens in a new window)
Architecture
- PHP block render callback (`tocguide/table-of-contents`), small editor script, optional ItemList JSON-LD.
- Reading Guide and study tools compute from post content or localStorage.
- No React runtime on the front end for the list itself.
- Independent slug tocguide.
Palette
-
Ink
#1b1f24 -
Forest
#275c3e -
Paper
#f7f9fc
These are the theme’s default colors. You can change them in the theme settings.
Handoff
How handoff works
-
Download the zip, turn the plugin on, and add the block. Settings are under Settings → TOCguide.
-
Source is on GitHub if you want to fork it.
Questions
Common questions
Is TOCguide really free?
Yes. $0 checkout captures your email for update notices if you want them, or download from GitHub Releases. No freemium lock.
Is TOCguide the same plugin as TOCflow?
Yes. TOCguide is the current name and slug (WordPress.org guideline 17). Re-insert the block and save Settings → TOCguide if you used an earlier zip.
Does it work with classic editor posts?
Yes. Use the [tocguide] shortcode. Heading anchors still inject on the front end.
Will it slow my site?
The list is in the first HTML response. Front-end JS is optional for sticky, scroll-spy, and study tools, and it respects prefers-reduced-motion.
Does it track readers?
No. No accounts, no analytics, no remote APIs. Study tools that use localStorage stay on the visitor's device.
Can you customize it for my theme?
Yes. Ask about this for sticky-header offsets, style presets that match your brand, or a private fork.
Feedback
What would you change?
Like or star this sample, leave a public note, or write me privately. I read every reply.
Visitor feedback
Like or star this project, or leave a note below.
Ask about this project
Name, email, and a few sentences. This goes straight to my inbox.
More projects
Theme Restaurants, taverns & inns
Cobble & Candle
A WordPress block theme for restaurants, taverns, cafés, and inns. Publish menus and hours, take table and room requests, and manage day-to-day changes in WordPress.
Sage WordPress Gutenberg Full Site Editing +2 more tools: Alpine.js, Tailwind
Theme Tour sites
WalkRidge
For tour companies with licensed guides. Visitors browse your tours, meet your guides, and book and pay online.
Sage WordPress WooCommerce Gutenberg +1 more tool: Customizer
Theme Real estate
Acreline
For real estate agents and small teams. Show your listings on a map, introduce your agents, and take showing requests, all on pages you can edit yourself.
Sage WordPress Gutenberg Customizer
Work with me
Like TOCguide?
Tell me what you would change, or write about a role. I usually reply within one business day (ET).
Visitor notes
No visitor notes yet. Say what you would change, or what you liked. ASCII, code, and plain punctuation are welcome.