Change Log

0.6.1 - 2021-01-01

This release provides some improvements to the code base:

  • ๐Ÿ› FIX: Do not resolve backslash escapes inside auto-links
  • ๐Ÿ› FIX: Add content to image tokens
  • ๐Ÿ‘Œ IMPROVE: Add more type annotations, thanks to @hukkinj1

0.6.0 - 2020-12-15

๐Ÿ—‘ DEPRECATE: Move plugins to mdit_py_plugins

Plugins (in markdown_it.extensions) have now been moved to executablebooks/mdit-py-plugins. This will allow for their maintenance to occur on a different cycle to the core code, facilitating the release of a v1.0.0 for this package

๐Ÿ”ง MAINTAIN: Add mypy type-checking, thanks to @hukkinj1.

0.5.8 - 2020-12-13

โœจ NEW: Add linkify, thanks to @tsutsu3.

This extension uses linkify-it-py to identify URL links within text:

  • -> <a href=""></a>

Important: To use this extension you must install linkify-it-py; pip install markdown-it-py[linkify]

It can then be activated by:

from markdown_it import MarkdownIt
md = MarkdownIt().enable("linkify")
md.options["linkify"] = True

0.5.7 - 2020-12-13

โœจ NEW: Add smartquotes, thanks to @tsutsu3.

This extension will convert basic quote marks to their opening and closing variants:

  • ‘single quotes’ -> โ€˜single quotesโ€™
  • “double quotes” -> โ€œdouble quotesโ€

It can be activated by:

from markdown_it import MarkdownIt
md = MarkdownIt().enable("smartquotes")
md.options["typographer"] = True

โœจ NEW: Add markdown-it-task-lists plugin, thanks to @wna-se.

This is a port of the JS markdown-it-task-lists, for building task/todo lists out of markdown lists with items starting with [ ] or [x]. For example:

- [ ] An item that needs doing
- [x] An item that is complete

This plugin can be activated by:

from markdown_it import MarkdownIt
from markdown_it.extensions.tasklists import tasklists_plugin
md = MarkdownIt().use(tasklists_plugin)

๐Ÿ› Various bug fixes, thanks to @hukkinj1:

  • Do not copy empty env arg in MarkdownIt.render
  • _Entities.__contains__ fix return data
  • Parsing of unicode ordinals
  • Handling of final character in skipSpacesBack and skipCharsBack methods
  • Avoid exception when document ends in heading/blockquote marker

๐Ÿงช TESTS: Add CI for Python 3.9 and PyPy3

0.5.6 - 2020-10-21

  • โœจ NEW: Add simple typographic replacements, thanks to @tsutsu3: This allows you to add the typographer option to the parser, to replace particular text constructs:

    • (c), (C) โ†’ ยฉ
    • (tm), (TM) โ†’ โ„ข
    • (r), (R) โ†’ ยฎ
    • (p), (P) โ†’ ยง
    • +- โ†’ ยฑ
    • ... โ†’ โ€ฆ
    • ?.... โ†’ ?..
    • !.... โ†’ !..
    • ???????? โ†’ ???
    • !!!!! โ†’ !!!
    • ,,, โ†’ ,
    • -- โ†’ &ndash
    • --- โ†’ &mdash
    md = MarkdownIt().enable("replacements")
    md.options["typographer"] = True
  • ๐Ÿ“š DOCS: Improve documentation for CLI, thanks to @westurner

  • ๐Ÿ‘Œ IMPROVE: Use re.sub() instead of re.subn()[0], thanks to @hukkinj1

  • ๐Ÿ› FIX: An exception raised by having multiple blank lines at the end of some files

0.5.5 - 2020-09-27

๐Ÿ‘Œ IMPROVE: Add store_labels option.

This allows for storage of original reference label in link/image token's metadata, which can be useful for renderers.

0.5.4 - 2020-09-08

โœจ NEW: Add anchors_plugin for headers, which can produce:

<h1 id="title-string">Title String <a class="header-anchor" href="#title-string">ยถ</a></h1>

0.5.3 - 2020-09-04

๐Ÿ› Fixed an undefined variable in the reference block.

0.5.2 - 2020-08-22

๐Ÿ› Fixed an IndexError in container_plugin, when there is no newline on the closing tag line.

0.5.1 - 2020-08-21

โฌ†๏ธ UPGRADE: attrs -> v20

This is not breaking, since it only deprecates Python 3.4 (see CHANGELOG.rst)

0.5.0 - 2020-08-18

Added โœจ

Improved ๐Ÿ‘Œ

Fixed ๐Ÿ›

  • Stopped empty lines at the end of the document, after certain list blocks, raising an exception (#36).
  • Allow myst-role to accept names containing digits (0-9).

0.4.9 - 2020-08-11

Added โœจ

Documented ๐Ÿ“š

  • Plugins and improved contributing section