Skip to content

Commit 6f87b32

Browse files
committed
Switch docs to mkdocs
1 parent 092c989 commit 6f87b32

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+333
-2168
lines changed

INSTALL.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@ As an Admin/Root user on your system do:
55

66
pip install markdown
77

8-
Or for more specific instructions, view the documentation in `docs/install.txt`
9-
or on the website at <https://pythonhosted.org/Markdown/install.html>.
8+
Or for more specific instructions, view the documentation in `docs/install.md`
9+
or on the website at <https://pythonhosted.org/Markdown/install/>.

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ on what exactly is supported and what is not. Additional features are
2323
supported by the [Available Extensions][].
2424

2525
[Markdown]: http://daringfireball.net/projects/markdown/
26-
[Features]: https://pythonhosted.org/Markdown/index.html#Features
27-
[Available Extensions]: https://pythonhosted.org/Markdown/extensions/index.html
26+
[Features]: https://pythonhosted.org/Markdown/index/#Features
27+
[Available Extensions]: https://pythonhosted.org/Markdown/extensions/
2828

2929

3030
Documentation
@@ -40,4 +40,4 @@ Support
4040
You may ask for help and discuss various other issues on the [mailing list][] and report bugs on the [bug tracker][].
4141

4242
[mailing list]: http://lists.sourceforge.net/lists/listinfo/python-markdown-discuss
43-
[bug tracker]: http://github.com/waylan/Python-Markdown/issues
43+
[bug tracker]: http://github.com/Python-Markdown/markdown/issues

checkspelling.sh

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
#!/bin/bash
22

33
echo "Building docs..."
4-
python setup.py --quiet build_docs --force
4+
mkdocs build --clean
55
echo "Compiling Dictionary..."
66
aspell --lang=en create master ./tmp <.spell-dict
7-
echo "Checking spelling...\n"
7+
echo "Checking spelling..."
88

99
let "fails=0"
1010

11-
for file in $(find build/docs/ -type f -name "*.html"); do
11+
for file in $(find site/ -type f -name "*.html"); do
1212
words=$(aspell list --lang=en --mode=html --add-html-skip=code --extra-dicts=./tmp <$file)
1313
if [ "$words" ]; then
1414
uniquewords=$(tr ' ' '\n' <<< "${words[@]}" | sort -u | tr '\n' ' ')
@@ -22,7 +22,7 @@ for file in $(find build/docs/ -type f -name "*.html"); do
2222
fi
2323
done
2424
rm -f ./tmp
25-
rm -rf build
25+
rm -rf site
2626

2727
if [ $fails -gt 0 ]; then
2828
echo "$fails files with misspelled words."
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/authors.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
title: Authors
2+
3+
Primary Authors
4+
===============
5+
6+
* __[Waylan Limberg](http://achinghead.com/)__
7+
8+
Waylan is the current maintainer of the code and has written much of the current
9+
code base, included a complete refactor of the core. He started out by
10+
authoring many of the available extensions and later was asked to join Yuri,
11+
where he began fixing numerous bugs, adding documentation and making general
12+
improvements to the existing code base.
13+
14+
15+
* __[Yuri Takteyev](http://freewisdom.org/)__
16+
17+
Yuri wrote most of the code found in version 1.x while procrastinating his Ph.D.
18+
Various pieces of his code still exist, most notably the basic structure.
19+
20+
* __[Manfed Stienstra](http://www.dwerg.net/)__
21+
22+
Manfed wrote the original version of the script and is responsible for
23+
various parts of the existing code base.
24+
25+
* __Artem Yunusov__
26+
27+
Artem, who as part of a 2008 GSoC project, refactored inline patterns,
28+
replaced the NanoDOM with ElementTree support and made various other
29+
improvements.
30+
31+
* __David Wolever__
32+
33+
David refactored the extension API and made other improvements
34+
as he helped to integrate Markdown into Dr.Project.
35+
36+
Other Contributors
37+
==================
38+
39+
The incomplete list of individuals below have provided patches or otherwise
40+
contributed to the project in various ways. We would like to thank everyone
41+
who has contributed to the project in any way.
42+
43+
* Eric Abrahamsen
44+
* Jeff Balogh
45+
* Sergej Chodarev
46+
* Chris Clark
47+
* Tiago Cogumbreiro
48+
* Kjell Magne Fauske
49+
* G. Clark Haynes
50+
* Daniel Krech
51+
* Steward Midwinter
52+
* Jack Miller
53+
* Neale Pickett
54+
* Paul Stansifer
55+
* John Szakmeister
56+
* Malcolm Tredinnick
57+
* Ben Wilson
58+
* and many others who helped by reporting bugs

docs/authors.txt

Lines changed: 0 additions & 60 deletions
This file was deleted.

docs/change_log.txt renamed to docs/change_log/index.md

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
11
title: Change Log
2-
prev_title: Test Suite
3-
prev_url: test_suite.html
4-
next_title: Release Notes for v2.6
5-
next_url: release-2.6.html
62

73
Python-Markdown Change Log
84
=========================
@@ -13,35 +9,35 @@ Mar 8, 2015: Released version 2.6.1 (a bug-fix release). The (new)
139
`yaml` option has been removed from the Meta-Data Extension as it was buggy
1410
(see [#390](https://github.com/waylan/Python-Markdown/issues/390)).
1511

16-
Feb 19, 2015: Released version 2.6 ([Notes](release-2.6.html)).
12+
Feb 19, 2015: Released version 2.6 ([Notes](release-2.6.md)).
1713

1814
Nov 19, 2014: Released version 2.5.2 (a bug-fix release).
1915

2016
Sept 26, 2014: Released version 2.5.1 (a bug-fix release).
2117

22-
Sept 12, 2014: Released version 2.5.0 ([Notes](release-2.5.html)).
18+
Sept 12, 2014: Released version 2.5.0 ([Notes](release-2.5.md)).
2319

24-
Feb 16, 2014: Released version 2.4.0 ([Notes](release-2.4.html)).
20+
Feb 16, 2014: Released version 2.4.0 ([Notes](release-2.4.md)).
2521

2622
Mar 22, 2013: Released version 2.3.1 (a bug-fix release).
2723

28-
Mar 14, 2013: Released version 2.3.0 ([Notes](release-2.3.html))
24+
Mar 14, 2013: Released version 2.3.0 ([Notes](release-2.3.md))
2925

30-
Nov 4, 2012: Released version 2.2.1 ([Notes](release-2.2.1.html)).
26+
Nov 4, 2012: Released version 2.2.1 (a bug-fix release).
3127

32-
Jul 5, 2012: Released version 2.2.0 ([Notes](release-2.2.0.html)).
28+
Jul 5, 2012: Released version 2.2.0 ([Notes](release-2.2.md)).
3329

34-
Jan 22, 2012: Released version 2.1.1 ([Notes](release-2.1.1.html)).
30+
Jan 22, 2012: Released version 2.1.1 (a bug-fix release).
3531

36-
Nov 24, 2011: Released version 2.1.0 ([Notes](release-2.1.0.html)).
32+
Nov 24, 2011: Released version 2.1.0 ([Notes](release-2.1.md)).
3733

38-
Oct 7, 2009: Released version 2.0.3.
34+
Oct 7, 2009: Released version 2.0.3. (a bug-fix release).
3935

40-
Sept 28, 2009: Released version 2.0.2 ([Notes](release-2.0.2.html)).
36+
Sept 28, 2009: Released version 2.0.2 (a bug-fix release).
4137

42-
May 20, 2009: Released version 2.0.1 ([Notes](release-2.0.1.html)).
38+
May 20, 2009: Released version 2.0.1 (a bug-fix release).
4339

44-
Mar 30, 2009: Released version 2.0 ([Notes](release-2.0.html)).
40+
Mar 30, 2009: Released version 2.0 ([Notes](release-2.0.md)).
4541

4642
Mar 8, 2009: Release Candidate 2.0-rc-1.
4743

docs/release-2.0.txt renamed to docs/change_log/release-2.0.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
11
title: Release Notes for v2.0
2-
prev_title: Release Notes for v2.0.1
3-
prev_url: release-2.0.1.html
4-
next_title: Authors
5-
next_url: authors.html
62

73
Python-Markdown 2.0 Release Notes
84
=================================
@@ -26,7 +22,7 @@ extensions, then you should not need to make any changes to your code.
2622
However, you may want to ensure that any third party extensions you are using
2723
are compatible with the new API.
2824

29-
The new extension API is fully [documented](extensions/api.html) in the docs.
25+
The new extension API is fully [documented](../extensions/api.md) in the docs.
3026
Below is a summary of the significant changes:
3127

3228
* 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
6763
makes it possible to include multiple extensions in a single module.
6864

6965
Numerous extensions are included in the distribution by default. See
70-
[available_extensions](extensions/index.html) for a complete list.
66+
[available_extensions](../extensions/index.md) for a complete list.
7167

72-
See the [Change Log](change_log.html) for a full list of changes.
68+
See the [Change Log](index.md) for a full list of changes.
7369

0 commit comments

Comments
 (0)