md-toc changelog ¶

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased ¶

Plan for 9.0.0 ¶

Remove the deprecated md_toc.exceptions.CannotTreatUnicodeString exception.
Snake case for all variables.

Plan for 8.2.0 ¶

Add code fence detection before writing TOC in place.

[8.1.4] - 2022-06-15 ¶

Changed ¶

Readme is now in markdown instead of rst.

Fixed ¶

Improved readme according to issue 36: better description of md-toc features compared to similar solutions.
Improved TOC marker detection and TOC substitution in place: replace an existing TOC only if
- the TOC is a list
- or there is no content between the TOC markers

[8.1.3] - 2022-04-20 ¶

Deprecated ¶

Deprecation of md_toc.exceptions.CannotTreatUnicodeString exception. This exception will be removed in version 9 of md-toc.

Fixed ¶

Memory improvements for operations on class instances.
Speed improvements for concatenation operations on strings.
Improved constants file.
Added square bracket support detection in emphasis for cmark. See issue 25
Note: GithHub Flavored Markdown is still at version 0.29. md-toc does its best to support both GFM 0.29 and cmark 0.30.

[8.1.2] - 2022-04-03 ¶

Fixed ¶

Added code span support detection in emphasis for cmark. See issue 25
Ported missing code changes from cmark 0.29 to 0.30.
Note: GithHub Flavored Markdown is still at version 0.29. md-toc does its best to support both GFM 0.29 and cmark 0.30.

Changed ¶

All cmark code has been split in separate Python modules: each module represents a C source file.
Documentation about markdown specification has been split in various files to improve readability.
Updated copyright headers.

[8.1.1] - 2022-01-27 ¶

Fixed ¶

Fixed issue 30: added full support for CommonMark 0.30.
Note:
- GithHub Flavored Markdown is still at version 0.29. md-toc does its best to support both GFM 0.29 and cmark 0.30.
- Previously missing implementations for the markdown emphasis removal have not been added with this release.
Improved adherence to upstream cmark code.
Added missing values in constants.
Imported fixes from fpydocs.
Updated copyright headers.

[8.1.0] - 2021-11-29 ¶

Fixed ¶

New line output is now handled correctly. See issue 33.
Updated copyright headers.
Imported fixes from fpydocs.
Metadata fixes in the setup.py file.

[8.0.1] - 2021-08-20 ¶

Fixed ¶

Cmark-specific code is now more adherent to the original.
License references are now more accurate.
The PyPI wheel is now made reproducible.
Updated email.

Changed ¶

Cmark-specific code has been moved to a separate Python module: cmark.py.

Added ¶

New git hooks have been added in the pre-commit file.
Examples for unit tests of Cmark 0.30 have been checked with the existing examples.

[8.0.0] - 2021-05-28 ¶

Changed ¶

Translated functions directly from cmark to treat emphasis.
get_md_header and get_atx_heading now support multiple lines.
Updated documentation.
Updated tests.
Updated package dependencies.

Added ¶

Newline string argument choice from the CLI.
Added these exceptions:
- StringCannotContainNewlines
- CannotTreatUnicodeString

Removed ¶

Removal of these functions:
- get_generic_fdr_indices
- get_fdr_indices
- can_open_emphasis
- can_close_emphasis
- get_nearest_list_id

back to software/md-toc

Comments