Skip to content

Releases: executablebooks/markdown-it-py

v3.0.0

03 Jun 06:33
bee6d19
Compare
Choose a tag to compare

v3.0.0 Release

⚠️ This release contains some minor breaking changes in the internal API and improvements to the parsing strictness.

Full Changelog: v2.2.0...v3.0.0

⬆️ UPGRADE: Drop support for Python 3.7

Also add testing for Python 3.11

⬆️ UPGRADE: Update from upstream markdown-it 12.2.0 to 13.0.0

A key change is the addition of a new Token type, text_special, which is used to represent HTML entities and backslash escaped characters.
This ensures that (core) typographic transformation rules are not incorrectly applied to these texts.
The final core rule is now the new text_join rule, which joins adjacent text/text_special tokens,
and so no text_special tokens should be present in the final token stream.
Any custom typographic rules should be inserted before text_join.

A new linkify rule has also been added to the inline chain, which will linkify full URLs (e.g. https://example.com),
and fixes collision of emphasis and linkifier (so http://example.org/foo._bar_-_baz is now a single link, not emphasized).
Emails and fuzzy links are not affected by this.

  • ♻️ Refactor backslash escape logic, add text_special #276
  • ♻️ Parse entities to text_special token #280
  • ♻️ Refactor: Add linkifier rule to inline chain for full links #279
  • ‼️ Remove (p) => § replacement in typographer #281
  • ‼️ Remove unused silent arg in ParserBlock.tokenize #284
  • 🐛 FIX: numeric character reference passing #272
  • 🐛 Fix: tab preventing paragraph continuation in lists #274
  • 👌 Improve nested emphasis parsing #273
  • 👌 fix possible ReDOS in newline rule #275
  • 👌 Improve performance of skipSpaces/skipChars #271
  • 👌 Show text of text_special in tree.pretty #282

♻️ REFACTOR: Replace most character code use with strings

The use of StateBase.srcCharCode is deprecated (with backward-compatibility), and all core uses are replaced by StateBase.src.

Conversion of source string characters to an integer representing the Unicode character is prevalent in the upstream JavaScript implementation, to improve performance.
However, it is unnecessary in Python and leads to harder to read code and performance deprecations (during the conversion in the StateBase initialisation).

See #270, thanks to @hukkinj1.

♻️ Centralise indented code block tests

For CommonMark, the presence of indented code blocks prevent any other block element from having an indent of greater than 4 spaces.
Certain Markdown flavors and derivatives, such as mdx and djot, disable these code blocks though, since it is more common to use code fences and/or arbitrary indenting is desirable.
Previously, disabling code blocks did not remove the indent limitation, since most block elements had the 3 space limitation hard-coded.
This change centralised the logic of applying this limitation (in StateBlock.is_code_block), and only applies it when indented code blocks are enabled.

This allows for e.g.

<div>
  <div>

    I can indent as much as I want here.

  <div>
<div>

See #260

🔧 Maintenance changes

Strict type annotation checking has been applied to the whole code base,
ruff is now used for linting,
and fuzzing tests have been added to the CI, to integrate with Google OSS-Fuzz testing, thanks to @DavidKorczynski.

  • 🔧 MAINTAIN: Make type checking strict #
  • 🔧 Add typing of rule functions #283
  • 🔧 Move linting from flake8 to ruff #268
  • 🧪 CI: Add fuzzing workflow for PRs #262
  • 🔧 Add tox env for fuzz testcase run #263
  • 🧪 Add OSS-Fuzz set up by @DavidKorczynski in #255
  • 🧪 Fix fuzzing test failures #254

v2.2.0

22 Feb 05:52
73a0147
Compare
Choose a tag to compare

What's Changed

New Contributors

Thanks to 🎉

Full Changelog: v2.1.0...v2.2.0

v2.1.0

16 Apr 13:51
7e677c4
Compare
Choose a tag to compare

What's Changed

New Contributors

Full Changelog: v2.0.1...v2.1.0

v2.0.1

24 Jan 17:58
d6adf66
Compare
Choose a tag to compare

What's Changed

  • 🐛 FIX: Crash when file ends with empty blockquote line by @hukkin in #186
  • ✨ NEW: Add inline_definitions option by @chrisjsewell in #187

Full Changelog: v2.0.0...v2.0.1

v2.0.0

03 Dec 08:44
465b54d
Compare
Choose a tag to compare

What's Changed

  • ⬆️ Update: Sync with markdown-it v12.1.0 and CommonMark v0.30 by @hukkin in #168
  • 📚 DOCS: Fix parameter-names and descriptions by @marcusatiliusregulus in #173
  • 🧪 TESTS: Test against python3.10 by @hukkin in #178
  • 🧪 TESTS: Add URL normalisation xfail by @hukkin in #170
  • 🐛 FIX: Always suffix indented code block with newline by @hukkin in #169
  • 👌 IMPROVE: Use all to signal re-exports by @hukkin in #120
  • ♻️ REFACTOR: Port mdurl and punycode for URL normalisation by @hukkin in #171
  • 🔧 MAINTAIN: Use pyproject-build for package deployment by @hukkin in #177
  • 📚 DOCS: punycode and mdurl are now used by @hukkin in #179
  • 🧪 TESTS: Remove needless xfail by @hukkin in #180
  • ♻️ REFACTOR: Remove AttrDict by @chrisjsewell in #181
  • 🚀 RELEASE: v2.0.0 by @chrisjsewell in #182

New Contributors

  • @marcusatiliusregulus made their first contribution in #173

Full Changelog: v1.1.0...v2.0.0

v1.1.0

08 May 05:22
1d27af1
Compare
Choose a tag to compare

v1.0.0

02 May 06:45
b0355bf
Compare
Choose a tag to compare

The first stable release of markdown-it-py 🎉

See CHANGELOG.md

v1.0.0b3

01 May 00:03
4319396
Compare
Choose a tag to compare
v1.0.0b3 Pre-release
Pre-release

v1.0.0b2

25 Apr 03:13
Compare
Choose a tag to compare
v1.0.0b2 Pre-release
Pre-release

v1.0.0b1

31 Mar 07:49
36c386d
Compare
Choose a tag to compare
v1.0.0b1 Pre-release
Pre-release