Jekyll Toc

Overview

The jekyll-toc Gem is a plugin for Jekyll that generates a table of contents (TOC) for your website or blog. It allows you to easily add a TOC to your pages and customize its appearance with CSS. This plugin is useful for websites with long articles or multiple sections, where a TOC can help readers navigate the content more easily.

Features

• Installation: Easily install the jekyll-toc Gem using your site's Gemfile and bundle install.
• Usage: Apply the toc filter and tags to generate the TOC and inject anchors into your content.
• Customization: Customize the TOC configuration, including the heading range, default settings, and CSS styling.
• TOC levels: Configure the heading levels to include in the TOC.
• Enable TOC by default: Set the TOC to appear by default on posts using Front Matter Defaults.
• Skip TOC: Exclude specific headings from the TOC by adding class attributes.
• CSS Styling: Modify the appearance of the TOC using custom CSS classes.
• Using Unordered/Ordered lists: Choose between unordered or ordered lists for the TOC.

Summary

The jekyll-toc Gem is a powerful plugin for Jekyll that allows you to easily add a table of contents to your website or blog. With its customizable features and easy installation process, it's a great tool for improving the navigation and user experience of your site. Whether you have long articles or multiple sections, the jekyll-toc Gem can help your readers find the information they need quickly and efficiently.