Beschreibung
Mocursor Smart TOC is a lightweight, feature-packed Gutenberg block that automatically generates a linked table of contents from the headings in your posts and pages. Simply drop it into your content — it just works. Also available as a [mctoc] shortcode for classic editor users.
The block is fully dynamic, accessible, lightweight, and theme-aware. It uses WordPress design tokens and CSS custom properties so it inherits your theme’s colors, fonts, and spacing automatically.
Shortcode Support
The Mocursor Smart TOC block is also available as a [mctoc] shortcode for use in the classic editor, widgets, or theme templates.
Basic usage:
[mctoc]
With options:
[mctoc title="On This Page" include_h2="true" include_h3="true" include_h4="false" numbering="nested" collapsed="true" sticky="true" offset="100" skip="1" exclude_headings="Related Posts,Comments" back_to_top="true"]
Available shortcode attributes:
title— TOC heading text (default: „Table of Contents“)include_h2— Include H2 headings: „true“ or „false“ (default: „true“)include_h3— Include H3 headings: „true“ or „false“ (default: „true“)include_h4— Include H4 headings: „true“ or „false“ (default: „true“)exclude_headings— Comma-separated heading texts to excludenumbering— Numbering style: „none“, „decimal“, or „nested“ (default: „none“)collapsed— Start collapsed: „true“ or „false“ (default: „false“)sticky— Enable sticky mode: „true“ or „false“ (default: „false“)offset— Scroll offset in pixels for fixed headers (default: 80)skip— Number of headings to skip from the start (default: 0)back_to_top— Show „Back to Top“ link: „true“ or „false“ (default: „false“)
Ideal Use Cases
Mocursor Smart TOC is perfect for:
- Long-form blog posts — Help readers navigate 2,000+ word articles with ease.
- Documentation and knowledge bases — Technical docs, how-to guides, and reference pages.
- Online courses and tutorials — Give learners a clear roadmap of every lesson section.
- Legal, policy, and compliance pages — Terms of service, privacy policies, and similar documents.
- Product and feature pages — Long product descriptions with multiple sections.
- Recipe and travel blogs — Readers can jump to the section they care about.
- Wiki-style internal sites — Any WordPress site used as an internal wiki or resource library.
- Accessibility-focused sites — The TOC gives keyboard and screen reader users a reliable way to navigate.
- Classic editor users — The shortcode works perfectly in the classic editor.
Why Choose Mocursor Smart TOC?
- Zero configuration needed — Drop the block in and it works immediately.
- 100% Gutenberg-native + Shortcode — Built as a real Gutenberg block with a classic shortcode fallback.
- Dynamic and always up to date — Server-rendered, always matches the current content.
- Incredibly lightweight — No JavaScript frameworks. Pure vanilla JS for all interactivity.
- Deeply customizable — Rich inspector controls for heading levels, numbering, collapsibility, sticky mode, and more.
- Accessible by default — Proper ARIA attributes, keyboard navigation, semantic HTML, and focus management.
- Theme-aware — Uses WordPress design tokens and CSS custom properties.
- No lock-in — Deactivate the plugin and your content is untouched.
- Privacy-friendly — No external requests, no tracking, no analytics, no cookies.
- Open source — Licensed under GPLv2.
Block Features
- Automatic heading detection for H2, H3, and H4
- Heading level filtering with individual checkboxes
- Exclude specific headings by text
- Skip first N headings option
- Three numbering styles: None, Decimal, Nested
- Collapsible TOC with configurable default state
- Smooth scrolling with configurable offset
- Active heading highlight via IntersectionObserver
- Back to Top link
- Sticky mode
- Live editor preview
- Full block editor design controls (colors, typography, spacing, borders)
- Shortcode support with full attribute control
How to Use
Method 1: Block Editor
- Install and activate the plugin.
- Open any post or page in the block editor.
- Click the block inserter (+), search for „Mocursor Smart TOC“, and insert the block.
- Customize via the block settings sidebar.
- Publish — the TOC renders with smooth scrolling and active heading tracking.
Method 2: Shortcode
- In any post, page, or widget, type
[mctoc]. - Optionally add attributes:
[mctoc title="Contents" numbering="decimal" collapsed="true"].
Method 3: PHP Template
<?php echo do_shortcode( '[mctoc title="Page Contents" numbering="nested"]' ); ?>
Tips:
- Place the TOC inside a Group block with a max-width for a contained look.
- Enable sticky mode for sidebar layouts.
- Use the shortcode in classic editor widgets or template files.
Blöcke
Dieses Plugin bietet 1 Block.
- Mocursor Smart TOC Automatically generates a linked table of contents from your post headings with smooth scrolling, numbering styles, and collapsible display.
FAQ
-
Does the TOC update automatically when I change headings?
-
Yes. The block is dynamically rendered on the server every time the page loads.
-
Which heading levels are supported?
-
The TOC block supports H2, H3, and H4. Toggle each level on or off independently.
-
Can I exclude specific headings from the TOC?
-
Yes. In the block settings or via the shortcode
excludeattribute, provide a comma-separated list of heading texts to omit. -
What happens if there are no headings?
-
The TOC block doesn’t render anything. No empty box, no broken layout.
-
Can I use the shortcode in the classic editor?
-
Yes. The
[mctoc]shortcode works in the classic editor, widgets, and theme templates. -
Does the plugin make any external requests?
-
No. Everything runs entirely on your server. Fully GDPR and privacy compliant.
Rezensionen
Für dieses Plugin gibt es keine Rezensionen.
Mitwirkende und Entwickler
„Mocursor Smart TOC“ ist Open-Source-Software. Folgende Menschen haben an diesem Plugin mitgewirkt:
MitwirkendeÜbersetze „Mocursor Smart TOC“ in deine Sprache.
Interessiert an der Entwicklung?
Durchstöbere den Code, sieh dir das SVN-Repository an oder abonniere das Entwicklungsprotokoll per RSS.
Änderungsprotokoll
1.0.2
- Added
[mctoc]shortcode support with full attribute control. - Enqueue frontend assets (CSS and JS) on shortcode usage for classic editor compatibility.
1.0.1
submitted to the plugins review team and added Documentation and plugin uri
0.1.0
- Initial release with Table of Contents block.
