Gatsby Remark Toc

Overview

The gatsby-remark-toc package was designed to enhance Markdown files by automatically generating a table of contents based on the headings present. Although it has been deprecated, those previously utilizing it can still appreciate its features, especially in creating well-organized documentation or blogs. If you’re looking for a more current solution, transitioning to gatsby-transformer-remark with GraphQL support for table of contents functionality is highly recommended.

Features

• Custom Placement: Easily specify where you want your table of contents to appear in your Markdown file by using the reuseExistingHeader option.
• List Type Flexibility: Change the format of your content list from unordered to ordered by enabling the orderedList option.
• Advanced Customization: Directly pass custom options to mdast-util-toc for further tailored results in your Markdown presentation.
• Integration with Gatsby: Seamlessly integrates with Gatsby projects, enhancing the overall Markdown editing experience.
• Automatic Updates: Automatically updates the table of contents when you change the headings in your document, ensuring accuracy and relevance.