Table of Contents

The Table of Contents (TOC) feature automatically generates a navigable index for your posts, improving content structure and reader navigation. This feature can be enabled globally or on specific posts.

Enabling TOC Globally

To enable the Table of Contents feature for all posts on your site, insert the following code snippet:

<script>
window.pvs?.initTOC?.();
</script>

This code snippet activates the Table of Contents for all posts on your site using the default headings h1, h2, and h3. To customize which headings appear, modify the headingsSelector value in the following code snippet:

<script>
window.pvs?.initTOC?.({
	headingsSelector: '.post-content > :where(h1, h2, h3)',
});
</script>

Enabling TOC for Specific Posts

If you prefer to enable the Table of Contents only for certain posts, you can use the internal tag system in Ghost:

1. Log in to Ghost admin
2. Go to Posts, and open the post
3. Open the Post settings sidebar
4. Add the #toc tag to Tags
5. Click Publish

The Table of Contents will now appear only on posts with the #toc internal tag.

Customizing TOC Headings

Our theme supports custom heading labels in the Table of Contents. This feature allows you to display different text in the TOC than what appears in the actual heading in your content.

To create a custom TOC heading:

1. In the Ghost editor, add an HTML card to your content
2. Insert your heading using the following format:

<h2 data-heading-label="Heading in TOC" id="heading-example">Heading Example</h2>

In this example:

• data-heading-label="Heading in TOC" defines the text that will appear in the Table of Contents
• id="heading-example" provides the anchor link for navigation
• Heading Example is the text that will appear in the actual content

This is particularly useful when you have longer headings in your content that you want to display in a more concise format in the TOC, or when you want to provide additional context in the TOC without changing your actual headings.

Disabling TOC for Specific Posts

In cases where you’ve enabled the Table of Contents globally but want to disable it for specific posts, you can use another internal tag:

1. Log in to Ghost admin
2. Go to Posts, and open the post
3. Open the Post settings sidebar
4. Add the #hide-toc tag to Tags
5. Click Publish

The Table of Contents will not appear on posts with the #hide-toc internal tag, even if it’s enabled globally.

Enabling TOC for Pages

If you prefer to enable the Table of Contents for certain pages, you can use the internal tag system in Ghost:

1. Log in to Ghost admin
2. Go to Pages, and open the post
3. Open the Post settings sidebar
4. Add the #toc tag to Tags
5. Click Publish

The Table of Contents will now appear on pages with the #toc internal tag in the content area.

If you prefer the Table of Contents in the sidebar, you’ll need to add it to your page separately. Learn more here