Switch docs to mkdocs

INSTALL.md

@@ -5,5 +5,5 @@ As an Admin/Root user on your system do:
 
     pip install markdown
 
-Or for more specific instructions, view the documentation in `docs/install.txt`
-or on the website at <https://pythonhosted.org/Markdown/install.html>.
+Or for more specific instructions, view the documentation in `docs/install.md`
+or on the website at <https://pythonhosted.org/Markdown/install/>.

README.md

@@ -23,8 +23,8 @@ on what exactly is supported and what is not. Additional features are
 supported by the [Available Extensions][].
 
 [Markdown]: http://daringfireball.net/projects/markdown/
-[Features]: https://pythonhosted.org/Markdown/index.html#Features
-[Available Extensions]: https://pythonhosted.org/Markdown/extensions/index.html
+[Features]: https://pythonhosted.org/Markdown/index/#Features
+[Available Extensions]: https://pythonhosted.org/Markdown/extensions/
 
 
 Documentation
@@ -40,4 +40,4 @@ Support
 You may ask for help and discuss various other issues on the [mailing list][] and report bugs on the [bug tracker][].
 
 [mailing list]: http://lists.sourceforge.net/lists/listinfo/python-markdown-discuss
-[bug tracker]: http://github.com/waylan/Python-Markdown/issues 
+[bug tracker]: http://github.com/Python-Markdown/markdown/issues 

checkspelling.sh

@@ -1,14 +1,14 @@
 #!/bin/bash
 
 echo "Building docs..."
-python setup.py --quiet build_docs --force
+mkdocs build --clean
 echo "Compiling Dictionary..."
 aspell --lang=en create master ./tmp <.spell-dict
-echo "Checking spelling...\n"
+echo "Checking spelling..."
 
 let "fails=0"
 
-for file in $(find build/docs/ -type f -name "*.html"); do
+for file in $(find site/ -type f -name "*.html"); do
     words=$(aspell list --lang=en --mode=html --add-html-skip=code --extra-dicts=./tmp  <$file)
     if [ "$words" ]; then
         uniquewords=$(tr ' ' '\n' <<< "${words[@]}" | sort -u | tr '\n' ' ')
@@ -22,7 +22,7 @@ for file in $(find build/docs/ -type f -name "*.html"); do
     fi
 done
 rm -f ./tmp
-rm -rf build
+rm -rf site
 
 if [ $fails -gt 0 ]; then
     echo "$fails files with misspelled words."

docs/authors.md

@@ -0,0 +1,58 @@
+title:      Authors
+
+Primary Authors
+===============
+
+*   __[Waylan Limberg](http://achinghead.com/)__
+
+    Waylan is the current maintainer of the code and has written much of the current 
+    code base, included a complete refactor of the core.  He started out by 
+    authoring many of the available extensions and later was asked to join Yuri, 
+    where he began fixing numerous bugs, adding documentation and making general 
+    improvements to the existing code base.
+
+
+*   __[Yuri Takteyev](http://freewisdom.org/)__
+
+    Yuri wrote most of the code found in version 1.x while procrastinating his Ph.D.
+    Various pieces of his code still exist, most notably the basic structure.
+
+*   __[Manfed Stienstra](http://www.dwerg.net/)__
+
+    Manfed wrote the original version of the script and is responsible for 
+    various parts of the existing code base.
+
+*   __Artem Yunusov__
+
+    Artem, who as part of a 2008 GSoC project, refactored inline patterns, 
+    replaced the NanoDOM with ElementTree support and made various other 
+    improvements.
+
+*   __David Wolever__
+
+    David refactored the extension API and made other improvements
+    as he helped to integrate Markdown into Dr.Project.
+
+Other Contributors
+==================
+
+The incomplete list of individuals below have provided patches or otherwise 
+contributed to the project in various ways. We would like to thank everyone 
+who has contributed to the project in any way.
+
+* Eric Abrahamsen
+* Jeff Balogh
+* Sergej Chodarev
+* Chris Clark
+* Tiago Cogumbreiro
+* Kjell Magne Fauske
+* G. Clark Haynes
+* Daniel Krech
+* Steward Midwinter
+* Jack Miller
+* Neale Pickett
+* Paul Stansifer
+* John Szakmeister
+* Malcolm Tredinnick
+* Ben Wilson
+* and many others who helped by reporting bugs

docs/change_log.txt → docs/change_log/index.md

@@ -1,8 +1,4 @@
 title:      Change Log
-prev_title: Test Suite
-prev_url:   test_suite.html
-next_title: Release Notes for v2.6
-next_url:   release-2.6.html
 
 Python-Markdown Change Log
 =========================
@@ -13,35 +9,35 @@ Mar 8, 2015: Released version 2.6.1 (a bug-fix release). The (new)
 `yaml` option has been removed from the Meta-Data Extension as it was buggy
 (see [#390](https://github.com/waylan/Python-Markdown/issues/390)).
 
-Feb 19, 2015: Released version 2.6 ([Notes](release-2.6.html)).
+Feb 19, 2015: Released version 2.6 ([Notes](release-2.6.md)).
 
 Nov 19, 2014: Released version 2.5.2 (a bug-fix release).
 
 Sept 26, 2014: Released version 2.5.1 (a bug-fix release).
 
-Sept 12, 2014: Released version 2.5.0 ([Notes](release-2.5.html)).
+Sept 12, 2014: Released version 2.5.0 ([Notes](release-2.5.md)).
 
-Feb 16, 2014: Released version 2.4.0 ([Notes](release-2.4.html)).
+Feb 16, 2014: Released version 2.4.0 ([Notes](release-2.4.md)).
 
 Mar 22, 2013: Released version 2.3.1 (a bug-fix release).
 
-Mar 14, 2013: Released version 2.3.0 ([Notes](release-2.3.html))
+Mar 14, 2013: Released version 2.3.0 ([Notes](release-2.3.md))
 
-Nov 4, 2012: Released version 2.2.1 ([Notes](release-2.2.1.html)).
+Nov 4, 2012: Released version 2.2.1 (a bug-fix release).
 
-Jul 5, 2012: Released version 2.2.0 ([Notes](release-2.2.0.html)).
+Jul 5, 2012: Released version 2.2.0 ([Notes](release-2.2.md)).
 
-Jan 22, 2012: Released version 2.1.1 ([Notes](release-2.1.1.html)).
+Jan 22, 2012: Released version 2.1.1 (a bug-fix release).
 
-Nov 24, 2011: Released version 2.1.0 ([Notes](release-2.1.0.html)).
+Nov 24, 2011: Released version 2.1.0 ([Notes](release-2.1.md)).
 
-Oct 7, 2009: Released version 2.0.3.
+Oct 7, 2009: Released version 2.0.3. (a bug-fix release).
 
-Sept 28, 2009: Released version 2.0.2 ([Notes](release-2.0.2.html)).
+Sept 28, 2009: Released version 2.0.2 (a bug-fix release).
 
-May 20, 2009: Released version 2.0.1 ([Notes](release-2.0.1.html)).
+May 20, 2009: Released version 2.0.1 (a bug-fix release).
 
-Mar 30, 2009: Released version 2.0 ([Notes](release-2.0.html)).
+Mar 30, 2009: Released version 2.0 ([Notes](release-2.0.md)).
 
 Mar 8, 2009: Release Candidate 2.0-rc-1.
 

docs/release-2.0.txt → docs/change_log/release-2.0.md

@@ -1,8 +1,4 @@
 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
 =================================
@@ -26,7 +22,7 @@ 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. 
+The new extension API is fully [documented](../extensions/api.md) in the docs. 
 Below is a summary of the significant changes:
 
 * The old home-grown NanoDOM has been replaced with ElementTree. Therefore all
@@ -67,7 +63,7 @@ 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.
+[available_extensions](../extensions/index.md) for a complete list.
 
-See the [Change Log](change_log.html) for a full list of changes.
+See the [Change Log](index.md) for a full list of changes.
 

docs/release-2.1.0.txt → docs/change_log/release-2.1.md

@@ -1,11 +1,7 @@
-title:      Release Notes for v2.1.0
-prev_title: Release Notes for v2.1.1
-prev_url:   release-2.1.1.html
-next_title: Release Notes for v2.0.2
-next_url:   release-2.0.2.html
+title:      Release Notes for v2.1
 
-Python-Markdown 2.1.0 Release Notes
-===================================
+Python-Markdown 2.1 Release Notes
+=================================
 
 We are pleased to release Python-Markdown 2.1 which makes many 
 improvements on 2.0. In fact, we consider 2.1 to be what 2.0 should have been. 
@@ -35,7 +31,7 @@ is suggested you manually use Python 3.1's 2to3 tool to do a conversion.
 wrapper methods. It now expects keyword arguments. Currently, the positional
 arguments should continue to work, but the solution feels hacky and may be 
 removed in a future version. All users are encouraged to use keyword arguments 
-as documented in the [Library Reference](reference.html).
+as documented in the [Library Reference](../reference.md).
 
 * Past versions of Python-Markdown provided module level Global variables which
 controlled the behavior of a few different aspects of the parser. Those global
@@ -44,13 +40,13 @@ Additionally, those attributes are settable as keyword arguments when
 initializing a class instance. Therefore, if you were editing the global 
 variables (either by editing the source or by overriding them in your code), 
 you should now set them on the class. See the 
-[Library Reference](reference.html) for the options available.
+[Library Reference](../reference.md) for the options available.
 
-* If you have been using the [HeaderId](extensions/header_id.html) extension 
+* If you have been using the HeaderId extension 
 to define custom ids on headers, you will want to switch to using the new 
-[Attribute List](extensions/attr_list.html) extension. The HeaderId extension 
+Attribute List extension. The HeaderId extension 
 now only auto-generates ids on headers which have not already had ids defined. 
-Note that the [Extra](extensions/extra.html) extension has been switched to use 
+Note that the Extra extension has been switched to use 
 Attribute Lists instead of HeaderId as it did previously.
 
 * Some code was moved into the `markdown.util` namespace which was previously
@@ -67,10 +63,10 @@ may want to remove them yourself as they are unlikely to work properly.
 What's New in Python-Markdown 2.1
 ---------------------------------
 
-Three new extensions were added. [Attribute Lists](extensions/attr_list.html), 
+Three new extensions were added. Attribute Lists, 
 which was inspired by Maruku's feature of the same name, 
-[Newline to Break](extensions/nl2br.html), which was inspired by GitHub 
-Flavored Markdown, and [Smart Strong](extensions/smart_strong.html), which 
+Newline to Break, which was inspired by GitHub 
+Flavored Markdown, and Smart Strong, which 
 fills a hole in the Extra extension.
 
 HTML5 is now supported. All this really means is that new block level elements 
@@ -115,7 +111,7 @@ script to accept input on `stdin`.
 The testing framework has been completely rebuilt using the Nose testing 
 framework. This provides a number of benefits including the ability to better
 test the built-in extensions and other options available to change the parsing 
-behavior. See the [Test Suite](test_suite.html) documentation for details.
+behavior. See the [Test Suite](../test_suite.md) documentation for details.
 
 Various bug fixes have been made, which are too numerous to list here. See the 
 [commit log](https://github.com/waylan/Python-Markdown/commits/master) for a 

docs/release-2.2.0.txt → docs/change_log/release-2.2.md

@@ -1,11 +1,7 @@
-title:      Release Notes for v2.2.0
-prev_title: Release Notes for v2.2.1
-prev_url:   release-2.2.1.html
-next_title: Release Notes for v2.1.1
-next_url:   release-2.1.1.html
+title:      Release Notes for v2.2
 
-Python-Markdown 2.2.0 Release Notes
-===================================
+Python-Markdown 2.2 Release Notes
+=================================
 
 We are pleased to release Python-Markdown 2.2 which makes improvements on 2.1. 
 While 2.2 is primarily a bug fix release, some internal improvements were made 
@@ -40,14 +36,14 @@ set to `True`. This change was made to prevent untrusted authors from injecting
 potentially harmful JavaScript in documents. This change had no effect when 
 not in `safe_mode`.
 
-What's New in Python-Markdown 2.1
+What's New in Python-Markdown 2.2
 ---------------------------------
 
 The docs were refactored and can now be found at 
 <http://packages.python.org/Markdown/>. The docs are now maintained in the
 Repository and are generated by the `setup.py build_docs` command.
 
-The [Sane_Lists](http://packages.python.org/Markdown/extensions/sane_lists.html)
+The Sane_Lists
 extension was added. The Sane Lists Extension alters the behavior of the 
 Markdown List syntax to be less surprising by not allowing the mixing of list
 types. In other words, an ordered list will not continue when an unordered list

docs/release-2.3.txt → docs/change_log/release-2.3.md

@@ -1,8 +1,4 @@
 title:      Release Notes for v2.3
-prev_title: Release Notes for v2.4
-prev_url:   release-2.4.html
-next_title: Release Notes for v2.2.1
-next_url:   release-2.2.1.html
 
 Python-Markdown 2.3 Release Notes
 =================================
@@ -40,12 +36,11 @@ you are outputting XHTML (the default) or HTML4.
 
 * The `force_linenos` configuration setting of the CodeHilite extension has been
 marked as **Pending Deprecation** and a new setting `linenums` has been added to
-replace it. See documentation for the [CodeHilite Extension] for an explanation
+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 it will raise a `PendingDeprecationWarning` 
 and will likely be removed in a future version of Python-Markdown.
 
-[CodeHilite Extension]: extensions/codehilite.html
 
 * The "RSS" extension has been removed and no longer ships with Python-Markdown.
 If you would like to continue using the extension (not recommended), it is 
@@ -75,12 +70,11 @@ sub-directory of another project. The various files within the library will
 still import each other properly even though 'markdown' may not be in Python's
 root namespace.
 
-* The [Admonition Extension] has been added, which implements [rST-style][rST] 
+* The Admonition Extension has been added, which implements [rST-style][rST] 
 admonitions in the Markdown syntax. However, be warned that this extension 
 is experimental and the syntax and behavior is still subject to change. Please 
 try it out and report bugs and/or improvements.
 
-[Admonition Extension]: extensions/admonition.html
 [rST]: http://docutils.sourceforge.net/docs/ref/rst/directives.html#specific-admonitions
 
 * Various bug fixes have been made.  See the