From b62ddeda02fadcd09def9354eb2ef46a7562a106 Mon Sep 17 00:00:00 2001 From: Waylan Limberg Date: Wed, 6 Dec 2017 23:18:29 -0500 Subject: 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. --- docs/release-2.0.txt | 73 ---------------------------------------------------- 1 file changed, 73 deletions(-) delete mode 100644 docs/release-2.0.txt (limited to 'docs/release-2.0.txt') diff --git a/docs/release-2.0.txt b/docs/release-2.0.txt deleted file mode 100644 index f44b0c5..0000000 --- a/docs/release-2.0.txt +++ /dev/null @@ -1,73 +0,0 @@ -title: Release Notes for v2.0 -prev_title: Release Notes for v2.0.1 -prev_url: release-2.0.1.html -next_title: Authors -next_url: authors.html - -Python-Markdown 2.0 Release Notes -================================= - -We are happy to release Python-Markdown 2.0, which has been over a year in the -making. We have rewritten significant portions of the code, dramatically -extending the extension API, increased performance, and added numerous -extensions to the distribution (including an extension that mimics PHP Markdown -Extra), all while maintaining backward compatibility with the end user API in -version 1.7. - -Python-Markdown supports Python versions 2.3, 2.4, 2.5, and 2.6. We have even -released a version converted to Python 3.0! - -Backwards-incompatible Changes ------------------------------- - -While Python-Markdown has experienced numerous internal changes, those changes -should only affect extension authors. If you have not written your own -extensions, then you should not need to make any changes to your code. -However, you may want to ensure that any third party extensions you are using -are compatible with the new API. - -The new extension API is fully [documented](extensions/api.html) in the docs. -Below is a summary of the significant changes: - -* The old home-grown NanoDOM has been replaced with ElementTree. Therefore all - extensions must use ElementTree rather than the old NanoDOM. -* The various processors and patterns are now stored with OrderedDicts rather - than lists. Any code adding processors and/or patterns into Python-Markdown - will need to be adjusted to use the new API using OrderedDicts. -* The various types of processors available have been either combined, added, - or removed. Ensure that your processors match the currently supported types. - -What's New in Python-Markdown 2.0 ---------------------------------- - -Thanks to the work of Artem Yunusov as part of GSoC 2008, Python-Markdown uses -ElementTree internally to build the (X)HTML document from markdown source text. -This has resolved various issues with the older home-grown NanoDOM and made -notable increases in performance. - -Artem also refactored the Inline Patterns to better support nested patterns -which has resolved many inconsistencies in Python-Markdown's parsing of the -markdown syntax. - -The core parser had been completely rewritten, increasing performance and, for -the first time, making it possible to override/add/change the way block level -content is parsed. - -Python-Markdown now parses markdown source text more closely to the other -popular implementations (Perl, PHP, etc.) than it ever has before. With the -exception of a few minor insignificant differences, any difference should be -considered a bug, rather than a limitation of the parser. - -The option to return HTML4 output as apposed to XHTML has been added. In -addition, extensions should be able to easily add additional output formats. - -As part of implementing markdown in the Dr. Project project (a Trac fork), among -other things, David Wolever refactored the "extension" keyword so that it -accepts either the extension names as strings or instances of extensions. This -makes it possible to include multiple extensions in a single module. - -Numerous extensions are included in the distribution by default. See -[available_extensions](extensions/index.html) for a complete list. - -See the [Change Log](change_log.html) for a full list of changes. - -- cgit v1.2.3