Pelican Toc

Overview

The Pelican TOC plugin is a handy tool that enhances the readability and organization of articles and pages in Pelican-generated websites. By automatically generating a table of contents, this plugin simplifies navigation for readers, ensuring they can easily jump to the sections that interest them most. With its lightweight setup, it's a perfect addition for anyone looking to improve their Pelican site without adding unnecessary complexity.

This plugin stands out by eliminating the need for manual entries like [ToC] in your articles. Instead, it intuitively builds the TOC based on your headings, making content management smoother and more efficient. Additionally, it offers customizability through metadata, allowing developers to tailor the TOC settings to their exact needs on a per-page basis.

Features

• Automatic TOC Generation: Instantly creates a table of contents based on article headings, enhancing navigation without manual effort.

• Custom Metadata Settings: Users can overwrite default TOC settings on a per page/article basis through simple metadata configurations.

• Compatibility with Beautiful Soup: Utilizes Beautiful Soup for robust TOC generation, ensuring that content is structured and easily accessible.

• Flexible Heading Options: Fully supports various heading levels (h1 to h4), allowing users to customize the TOC structure according to their content layout.

• Health Check for IDs: Incorporates a health check on generated IDs to avoid potential issues with markdown extensions, ensuring clean and functional output.

• No Markdown Tags Required: Streamlines the writing process by removing the need to insert specific markdown tags like [ToC], resulting in a cleaner writing experience.