diff options
author | Waylan Limberg <waylan.limberg@icloud.com> | 2017-12-06 23:18:29 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2017-12-06 23:18:29 -0500 |
commit | b62ddeda02fadcd09def9354eb2ef46a7562a106 (patch) | |
tree | 37149361ca1eeb8c24942835b2f933105fa920ed /docs/release-2.4.txt | |
parent | de5c696f94e8dde242c29d4be50b7bbf3c17fedb (diff) | |
download | markdown-b62ddeda02fadcd09def9354eb2ef46a7562a106.tar.gz markdown-b62ddeda02fadcd09def9354eb2ef46a7562a106.tar.bz2 markdown-b62ddeda02fadcd09def9354eb2ef46a7562a106.zip |
Switch docs to MKDocs (#602)
Fixes #601. Merged in 6f87b32 from the md3 branch and did a lot of cleanup.
Changes include:
* Removed old docs build tool, templates, etc.
* Added MkDocs config file, etc.
* filename.txt => filename.md
* pythonhost.org/Markdown => Python-Markdown.github.io
* Markdown lint and other cleanup.
* Automate pages deployment in makefile with `mkdocs gh-deploy`
Assumes a git remote is set up named "pages". Do
git remote add pages https://github.com/Python-Markdown/Python-Markdown.github.io.git
... before running `make deploy` the first time.
Diffstat (limited to 'docs/release-2.4.txt')
-rw-r--r-- | docs/release-2.4.txt | 77 |
1 files changed, 0 insertions, 77 deletions
diff --git a/docs/release-2.4.txt b/docs/release-2.4.txt deleted file mode 100644 index f1d00af..0000000 --- a/docs/release-2.4.txt +++ /dev/null @@ -1,77 +0,0 @@ -title: Release Notes for v2.4 -prev_title: Release Notes for v2.5 -prev_url: release-2.5.html -next_title: Release Notes for v2.3 -next_url: release-2.3.html - -Python-Markdown 2.4 Release Notes -================================= - -We are pleased to release Python-Markdown 2.4 which adds one new extension -and fixes various bugs. See the list of changes below for details. - -Python-Markdown supports Python versions 2.6, 2.7, 3.1, 3.2, and 3.3. - -Backwards-incompatible Changes ------------------------------- - -* The `force_linenos` configuration setting of the CodeHilite extension has been -marked as **Deprecated**. It had previously been marked as "Pending Deprecation" -in version 2.3 when a new setting `linenums` was added to replace it. See -documentation for the [CodeHilite Extension] for an explanation of the new -`linenums` setting. The new setting will honor the old `force_linenos` if it -is set, but `force_linenos` will raise a `DeprecationWarning` and will likely -be removed in a future version of Python-Markdown. - -[CodeHilite Extension]: extensions/code_hilite.html - -* URLs are no longer percent-encoded. This improves compatibility with the -original (written in Perl) Markdown implementation. Please percent-encode -your URLs manually when needed. - -What's New in Python-Markdown 2.4 ---------------------------------- - -* Thanks to the hard work of [Dmitry Shachnev] the [Smarty Extension] has been -added, which implements [SmartyPants] using Python-Markdown's Extension API. -This offers a few benefits over a third party script. The HTML does not need -to be "tokenized" twice, no hacks are required to combine SmartyPants and -code highlighting, and we get markdown's escaping feature for free. Please try -it out and report bugs and/or improvements. - -[Dmitry Shachnev]: https://github.com/mitya57 -[Smarty Extension]: extensions/smarty.html -[SmartyPants]: http://daringfireball.net/projects/smartypants/ - -* The [Table of Contents Extension] now supports new `permalink` option -for creating [Sphinx]-style anchor links. - -[Table of Contents Extension]: extensions/toc.html -[Sphinx]: http://sphinx-doc.org/ - -* It is now possible to enable Markdown formatting inside HTML blocks by -appending `markdown=1` to opening tag attributes. See [Markdown Inside HTML -Blocks] section for details. Thanks to [ryneeverett] for implementing this -feature. - -[Markdown Inside HTML Blocks]: extensions/extra.html#nested-markdown-inside-html-blocks -[ryneeverett]: https://github.com/ryneeverett - -* The code blocks now support emphasizing some of the code lines. To use this -feature, specify `hl_lines` option after language name, for example (using -the [Fenced Code Extension]): - - ```.python hl_lines="1 3" - # This line will be emphasized. - # This one won't. - # This one will be also emphasized. - ``` - - Thanks to [A. Jesse Jiryu Davis] for implementing this feature. - -[Fenced Code Extension]: extensions/fenced_code_blocks.html -[A. Jesse Jiryu Davis]: https://github.com/ajdavis - -* Various bug fixes have been made. See the -[commit log](https://github.com/Python-Markdown/markdown/commits/master) -for a complete history of the changes. |