Skip to content

Commit b010479

Browse files
committed
Switch to MKDocs
This is a work in progress. I merged in 6f87b32 from the md3 branch. That branch has all of the extension docs removed, so they haven't been converted yet. And I only resolved conflicts and updated mkdocs.yml to the current MkDocs format. Addresses Python-Markdown#601.
1 parent de5c696 commit b010479

34 files changed

+398
-1413
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: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,23 @@
88
[![BSD License](http://img.shields.io/badge/license-BSD-yellow.svg)](http://opensource.org/licenses/BSD-3-Clause)
99
[![Code of Conduct](https://img.shields.io/badge/code%20of%20conduct-contributor%20covenant-green.svg?style=flat-square)][Code of Conduct]
1010

11-
This is a Python implementation of John Gruber's [Markdown][].
11+
This is a Python implementation of John Gruber's [Markdown][].
1212
It is almost completely compliant with the reference implementation,
13-
though there are a few known issues. See [Features][] for information
14-
on what exactly is supported and what is not. Additional features are
13+
though there are a few known issues. See [Features][] for information
14+
on what exactly is supported and what is not. Additional features are
1515
supported by the [Available Extensions][].
1616

1717
[Python-Markdown]: https://pythonhosted.org/Markdown/
1818
[Markdown]: http://daringfireball.net/projects/markdown/
19-
[Features]: https://pythonhosted.org/Markdown/index.html#Features
20-
[Available Extensions]: https://pythonhosted.org/Markdown/extensions/index.html
19+
[Features]: https://pythonhosted.org/Markdown/index/#Features
20+
[Available Extensions]: https://pythonhosted.org/Markdown/extensions/
2121

2222

2323
Documentation
2424
-------------
2525

2626
Installation and usage documentation is available in the `docs/` directory
27-
of the distribution and on the project website at
27+
of the distribution and on the project website at
2828
<https://pythonhosted.org/Markdown/>.
2929

3030
See the change log at <https://pythonhosted.org/Markdown/change_log.html>.
@@ -35,7 +35,7 @@ Support
3535
You may ask for help and discuss various other issues on the [mailing list][] and report bugs on the [bug tracker][].
3636

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

4040
Code of Conduct
4141
---------------

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."

docs/_template.html

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

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.

0 commit comments

Comments
 (0)