Jekyll Toc Versions Save

New

• Add support for a new flat_toc parameter that allows the table of contents to be rendered at a single level (#70)

Fixes

• Fix quotes causing breakage in unit tests (#65)

Breaking

• Dropped support for versions of Jekyll below 3.5.0; if you're using an older version of Jekyll, continue to use the 1.1.x series of this project

Fixes

• Correctly generate an empty string if there was no TOC generated. This allows for quicker checking than having to trim the TOC by yourself every time (#60)

A complete rewrite of the ToC generation logic to no longer use markdown.

New

• Table of Contents are now generated with HTML manually instead of using kramdown specific markup; meaning we now support more markdown engines such as GFM.

Deprecations

• The baseurl parameter has been deprecated; use the renamed base_url parameter instead
• The skipNoIDs parameter has been deprecated; use the renamed skip_no_ids parameter instead

Development

• The unit testing script uses Python 3 now

New

• Allow applying classes to nested <ul>s within the TOC (#40, #43)

Fixes

• Fix skipNoIDs logic when more IDs in other HTML elements (#42)

Fixes

• Address issue with {: .no_toc} being used on the first header and this snippet generating TOC markup incorrectly as a code block (#35, #36)

New

• Add new skipNoIDs parameter that will allow you to skip headers with no IDs
  • Warning: This snippet still expects a valid document header structure to render a correct TOC
  • See _tests/skipHeadingsWithNoIDs.md for example usage

Fixes

• Don't render an empty anchor link to # if a heading does not have an ID; now it will render plain text instead
  • See _tests/noAnchorOnHeadingsWithNoIDs.md for example usage

Fixes

• Hotfix for one of the logic improvements introduced in 1.0.9

An incredibly minor maintenance release that won't affect the majority of users. You only need to update to this version if you are a redcarpet user.

If you're using kramdown, this release does not do anything different for you.

Fixes

• Fix logic mistakes in our code
  • Remove unnecessary "addition" that was "happening" in our heading count (#26)
  • Don't generate empty {:.} markup in list items when include.item_class was empty (#29)

Fixes

• | in headers no longer causes TOC to render incorrectly (#24)