Shortcode Table of Contents Shortcode Table of Contents

Shortcode Table of Contents

Created by: James Kemp

Rating:
Downloaded: 26k times

Simply use the [toc content=".your-container"] shortcode to automatically generate a table of contents for any HTML container.

The shortcode accepts a number of parameters:

  • content string required
    A CSS selector indicating the container of your content.
  • headers string
    A comma separated list of heading selectors that you want to include.
  • speed int
    Speed of sliding back to top.
  • anchor-class string
    Class of anchor links.
  • anchor-text string
    Prepended or appended to anchor headings. Leave blank to disable anchor links.
  • top_class string
    Back to top button or link class.
  • spy true/false
    Enable scroll spy. This will highlight the list items as you scroll past them.
  • position append/prepend
    Position of anchor text.
  • spy-offset int
    Specify heading offset for spy scrolling.

Screenshots

  • Add the <code>[toc]</code> shortcode to any post/page/custom-post-type, at any position in the content.
  • A nested list will be generated based on the headings within your chosen HTML element.
  • Add the <code>anchor-text</code> parameter.
  • When the <code>anchor-text</code> parameter is set, the text will be appended to your headings so your users can easily copy the link to that section.

Categories

Get New Themes & Resources