Skip to content

Commit

Permalink
Bump version to 3.6
Browse files Browse the repository at this point in the history
  • Loading branch information
waylan committed Mar 14, 2024
1 parent 3d8afc6 commit e524b8f
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 11 deletions.
1 change: 1 addition & 0 deletions .spell-dict
Expand Up @@ -152,6 +152,7 @@ unescape
unescaping
unittest
unordered
unsanitized
untrusted
UTF
uTidylib
Expand Down
24 changes: 14 additions & 10 deletions docs/changelog.md
Expand Up @@ -8,26 +8,30 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). See the [Contributing Guide](contributing.md) for details.

## [unreleased]
## [3.6] -- 2024-03-14

### Changed

#### Refactor TOC Sanitation

* All postprocessors are run on heading content.
* Footnote references are stripped from heading content. Fixes #660.
* All postprocessors are now run on heading content.
* Footnote references are now stripped from heading content. Fixes #660.
* A more robust `striptags` is provided to convert headings to plain text.
Unlike, the `markupsafe` implementation, HTML entities are not unescaped.
* The plain text `name`, rich `html` and unescaped raw `data-toc-label` are
* The plain text `name`, rich `html`, and unescaped raw `data-toc-label` are
saved to `toc_tokens`, allowing users to access the full rich text content of
the headings directly from `toc_tokens`.
* `data-toc-label` is sanitized separate from heading content.
* A `html.unescape` call is made just prior to calling `slugify` so that
* The value of `data-toc-label` is sanitized separate from heading content
before being written to `name`. This fixes a bug which allowed markup through
in certain circumstances. To access the raw unsanitized data, retrieve the
value from `token['data-toc-label']` directly.
* An `html.unescape` call is made just prior to calling `slugify` so that
`slugify` only operates on Unicode characters. Note that `html.unescape` is
not run on the `name` or `html`.
* The `get_name` and `stashedHTML2text` functions defined in the `toc` extension
are both **deprecated**. Instead, use some combination of `run_postprocessors`,
`render_inner_html` and `striptags`.
not run on `name`, `html`, or `data-toc-label`.
* The functions `get_name` and `stashedHTML2text` defined in the `toc` extension
are both **deprecated**. Instead, third party extensions should use some
combination of the new functions `run_postprocessors`, `render_inner_html` and
`striptags`.

### Fixed

Expand Down
2 changes: 1 addition & 1 deletion markdown/__meta__.py
Expand Up @@ -28,7 +28,7 @@
from __future__ import annotations


__version_info__ = (3, 5, 2, 'final', 0)
__version_info__ = (3, 6, 0, 'final', 0)


def _get_version(version_info):
Expand Down

0 comments on commit e524b8f

Please sign in to comment.