Debian Codegraph @

docs/change_log/release-2.4.md

raw
1 title: Release Notes for v2.4
2
3 Python-Markdown 2.4 Release Notes
4 =================================
5
6 We are pleased to release Python-Markdown 2.4 which adds one new extension
7 and fixes various bugs. See the list of changes below for details.
8
9 Python-Markdown supports Python versions 2.6, 2.7, 3.1, 3.2, and 3.3.
10
11 Backwards-incompatible Changes
12 ------------------------------
13
14 * The `force_linenos` configuration setting of the CodeHilite extension has been
15 marked as **Deprecated**. It had previously been marked as "Pending
16 Deprecation" in version 2.3 when a new setting `linenums` was added to replace
17 it. See documentation for the [CodeHilite Extension] for an explanation of the
18 new `linenums` setting. The new setting will honor the old `force_linenos` if
19 it is set, but `force_linenos` will raise a `DeprecationWarning` and will
20 likely be removed in a future version of Python-Markdown.
21
22 [CodeHilite Extension]: ../extensions/code_hilite.md
23
24 * URLs are no longer percent-encoded. This improves compatibility with the
25 original (written in Perl) Markdown implementation. Please percent-encode your
26 URLs manually when needed.
27
28 What's New in Python-Markdown 2.4
29 ---------------------------------
30
31 * Thanks to the hard work of [Dmitry Shachnev] the [Smarty Extension] has been
32 added, which implements [SmartyPants] using Python-Markdown's Extension API.
33 This offers a few benefits over a third party script. The HTML does not need
34 to be "tokenized" twice, no hacks are required to combine SmartyPants and code
35 highlighting, and we get markdown's escaping feature for free. Please try it
36 out and report bugs and/or improvements.
37
38 [Dmitry Shachnev]: https://github.com/mitya57
39 [Smarty Extension]: ../extensions/smarty.md
40 [SmartyPants]: https://daringfireball.net/projects/smartypants/
41
42 * The [Table of Contents Extension] now supports new `permalink` option for
43 creating [Sphinx]-style anchor links.
44
45 [Table of Contents Extension]: ../extensions/toc.md
46 [Sphinx]: http://sphinx-doc.org/
47
48 * It is now possible to enable Markdown formatting inside HTML blocks by
49 appending `markdown=1` to opening tag attributes. See [Markdown Inside HTML
50 Blocks] section for details. Thanks to [ryneeverett] for implementing this
51 feature.
52
53 [Markdown Inside HTML Blocks]: ../extensions/md_in_html.md
54 [ryneeverett]: https://github.com/ryneeverett
55
56 * The code blocks now support emphasizing some of the code lines. To use this
57 feature, specify `hl_lines` option after language name, for example (using the
58 [Fenced Code Extension]):
59
60 ```.python hl_lines="1 3"
61 # This line will be emphasized.
62 # This one won't.
63 # This one will be also emphasized.
64 ```
65
66 Thanks to [A. Jesse Jiryu Davis] for implementing this feature.
67
68 [Fenced Code Extension]: ../extensions/fenced_code_blocks.md
69 [A. Jesse Jiryu Davis]: https://github.com/ajdavis
70
71 * Various bug fixes have been made. See the [commit
72 log](https://github.com/Python-Markdown/markdown/commits/master) for a
73 complete history of the changes.