Jekyll Table Of Contents

screenshot of Jekyll Table Of Contents

A simple JavaScript table of contents, designed for Jekyll (or similar) sites.

Overview

The jekyll-table-of-contents is a simple JavaScript table of contents generator that works well with Jekyll static sites. It automatically generates a table of contents based on the headers in your HTML document.

Features

  • Basic Usage: Easily add a table of contents to your Jekyll static site.
  • Configuration: Customize the appearance and behavior of the table of contents.
  • Header Styling: Add an arrow and a permanent link to each header.
  • Headers Used: Choose which headers to include in the table of contents.
  • Effects: Choose from different display effects for the table of contents.
  • List and Item Styling: Customize the CSS classes for the table of contents elements.

Summary

The jekyll-table-of-contents is a JavaScript library that simplifies the process of adding a table of contents to Jekyll static sites. It offers easy configuration options, header styling, and effects. It is a useful tool for organizing and navigating long articles or documents.