Skip to content

Commit 3d1c70c

Browse files
committed
Converted extension docs to mkdocs.
1 parent faacead commit 3d1c70c

22 files changed

+84
-220
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ test-output.html
66
build/*
77
dist/*
88
tmp/*
9+
site/*
910
MANIFEST
1011
.venv
1112
*~

docs/extensions/abbreviations.txt renamed to docs/extensions/abbreviations.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
1-
title: Abbreviations Extension
2-
prev_title: Extra Extension
3-
prev_url: extra.html
4-
next_title: Attribute Lists Extension
5-
next_url: attr_list.html
1+
title: Abbreviations Extension
62

73
Abbreviations
84
=============
@@ -39,7 +35,7 @@ will be rendered as:
3935
Usage
4036
-----
4137

42-
See [Extensions](index.html) for general extension usage, specify `markdown.extensions.abbr`
38+
See [Extensions](index.md) for general extension usage, specify `markdown.extensions.abbr`
4339
as the name of the extension.
4440

4541
This extension does not accept any special configuration options.

docs/extensions/admonition.txt renamed to docs/extensions/admonition.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
1-
title: Admonition Extension
2-
prev_title: Smart Strong Extension
3-
prev_url: smart_strong.html
4-
next_title: CodeHilite Extension
5-
next_url: code_hilite.html
1+
title: Admonition Extension
62

73
Admonition
84
==========

docs/extensions/api.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
11
title: Extensions API
2-
prev_title: WikiLinks Extension
3-
prev_url: wikilinks.html
4-
next_title: Test Suite
5-
next_url: ../test_suite.html
62

73
Writing Extensions for Python-Markdown
84
======================================

docs/extensions/attr_list.txt renamed to docs/extensions/attr_list.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
1-
title: Attribute Lists Extension
2-
prev_title: Abbreviations Extension
3-
prev_url: abbreviations.html
4-
next_title: Definition Lists Extension
5-
next_url: definition_lists.html
1+
title: Attribute Lists Extension
62

73
Attribute Lists
84
===============
@@ -82,7 +78,7 @@ The above results in the following output:
8278
Usage
8379
-----
8480

85-
See [Extensions](index.html) for general extension usage, specify `markdown.extensions.attr_list`
86-
as the name of the extension.
81+
See [Extensions](index.md) for general extension usage, specify
82+
`markdown.extensions.attr_list` as the name of the extension.
8783

8884
This extension does not accept any special configuration options.

docs/extensions/code_hilite.txt renamed to docs/extensions/code_hilite.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
1-
title: CodeHilite Extension
2-
prev_title: Admonition Extension
3-
prev_url: admonition.html
4-
next_title: HeaderId Extension
5-
next_url: header_id.html
1+
title: CodeHilite Extension
62

73
CodeHilite
84
==========
@@ -162,10 +158,10 @@ Lets see the source for that:
162158
Usage
163159
-----
164160

165-
See [Extensions](index.html) for general extension usage, specify
161+
See [Extensions](index.md) for general extension usage, specify
166162
`markdown.extensions.codehilite` as the name of the extension.
167163

168-
See the [Library Reference](../reference.html#extensions) for information about
164+
See the [Library Reference](../reference.md#extensions) for information about
169165
configuring extensions.
170166

171167
The following options are provided to configure the output:

docs/extensions/definition_lists.txt renamed to docs/extensions/definition_lists.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
1-
title: Definition Lists Extension
2-
prev_title: Attribute Lists Extension
3-
prev_url: attr_list.html
4-
next_title: Fenced Code Blocks Extension
5-
next_url: fenced_code_blocks.html
1+
title: Definition Lists Extension
62

73
Definition Lists
84
================
@@ -47,7 +43,7 @@ will be rendered as:
4743
Usage
4844
-----
4945

50-
See [Extensions](index.html) for general extension usage, specify `markdown.extensions.def_list`
51-
as the name of the extension.
46+
See [Extensions](index.md) for general extension usage, specify
47+
`markdown.extensions.def_list` as the name of the extension.
5248

5349
This extension does not accept any special configuration options.

docs/extensions/extra.txt renamed to docs/extensions/extra.md

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
1-
title: Extra Extension
2-
prev_title: Extensions
3-
prev_url: index.html
4-
next_title: Abbreviations Extension
5-
next_url: abbreviations.html
1+
title: Extra Extension
62

73
Python-Markdown Extra
84
=====================
@@ -15,13 +11,13 @@ A compilation of various Python-Markdown extensions that (mostly) imitates
1511

1612
The supported extensions include:
1713

18-
* [Abbreviations](abbreviations.html)
19-
* [Attribute Lists](attr_list.html)
20-
* [Definition Lists](definition_lists.html)
21-
* [Fenced Code Blocks](fenced_code_blocks.html)
22-
* [Footnotes](footnotes.html)
23-
* [Tables](tables.html)
24-
* [Smart Strong](smart_strong.html)
14+
* [Abbreviations](abbreviations.md)
15+
* [Attribute Lists](attr_list.md)
16+
* [Definition Lists](definition_lists.md)
17+
* [Fenced Code Blocks](fenced_code_blocks.md)
18+
* [Footnotes](footnotes.md)
19+
* [Tables](tables.md)
20+
* [Smart Strong](smart_strong.md)
2521

2622
See each individual extension for syntax documentation. Extra and all its
2723
supported extensions are included in the standard Markdown library.
@@ -34,13 +30,13 @@ From the Python interpreter:
3430
>>> import markdown
3531
>>> html = markdown.markdown(text, ['markdown.extensions.extra'])
3632

37-
There may be [additional extensions](index.html) that are distributed with
33+
There may be [additional extensions](index.md) that are distributed with
3834
Python-Markdown that are not included here in Extra. The features
3935
of those extensions are not part of PHP Markdown Extra, and
4036
therefore, not part of Python-Markdown Extra. If you really would
4137
like Extra to include additional extensions, we suggest creating
4238
your own clone of Extra under a different name
43-
(see the [Extension API](api.html)).
39+
(see the [Extension API](api.md)).
4440

4541
Markdown Inside HTML Blocks
4642
---------------------------

docs/extensions/fenced_code_blocks.txt renamed to docs/extensions/fenced_code_blocks.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
1-
title: Fenced Code Blocks Extension
2-
prev_title: Definition Lists Extension
3-
prev_url: definition_lists.html
4-
next_title: Footnotes Extension
5-
next_url: footnotes.html
1+
title: Fenced Code Blocks Extension
62

73
Fenced Code Blocks
84
==================
@@ -106,7 +102,7 @@ The lines can be specified with PHP Extra's syntax:
106102
Usage
107103
-----
108104

109-
See [Extensions](index.html) for general extension usage, specify `markdown.extensions.fenced_code`
110-
as the name of the extension.
105+
See [Extensions](index.md) for general extension usage, specify
106+
`markdown.extensions.fenced_code` as the name of the extension.
111107

112108
This extension does not accept any special configuration options.

docs/extensions/footnotes.txt renamed to docs/extensions/footnotes.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
1-
title: Footnotes Extension
2-
prev_title: Fenced Code Blocks Extension
3-
prev_url: fenced_code_blocks.html
4-
next_title: Tables Extension
5-
next_url: tables.html
1+
title: Footnotes Extension
62

73
Footnotes
84
=========
@@ -64,10 +60,10 @@ is indented consistently and any errors are more easily discernible by the autho
6460
Usage
6561
-----
6662

67-
See [Extensions](index.html) for general extension usage, specify `markdown.extensions.footnotes`
68-
as the name of the extension.
63+
See [Extensions](index.md) for general extension usage, specify
64+
`markdown.extensions.footnotes` as the name of the extension.
6965

70-
See the [Library Reference](../reference.html#extensions) for information about
66+
See the [Library Reference](../reference.md#extensions) for information about
7167
configuring extensions.
7268

7369
The following options are provided to configure the output:

docs/extensions/header_id.txt renamed to docs/extensions/header_id.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
1-
title: HeaderId Extension
2-
prev_title: CodeHilite Extension
3-
prev_url: code_hilite.html
4-
next_title: Meta-Data Extension
5-
next_url: meta_data.html
1+
title: HeaderId Extension
62

73
HeaderId
84
========
@@ -20,7 +16,7 @@ This extension is included in the standard Markdown library.
2016
Extension should be used instead, which offers most the features of this
2117
extension and more.
2218

23-
[toc]: toc.html
19+
[toc]: toc.md
2420

2521
Syntax
2622
------
@@ -42,10 +38,10 @@ Results in:
4238
Usage
4339
-----
4440

45-
See [Extensions](index.html) for general extension usage, specify `markdown.extensions.headerid`
46-
as the name of the extension.
41+
See [Extensions](index.md) for general extension usage, specify
42+
`markdown.extensions.headerid` as the name of the extension.
4743

48-
See the [Library Reference](../reference.html#extensions) for information about
44+
See the [Library Reference](../reference.md#extensions) for information about
4945
configuring extensions.
5046

5147
The following options are provided to configure the output:
@@ -74,7 +70,7 @@ The following options are provided to configure the output:
7470

7571
The `forceid` setting turns on or off the automatically generated ids for
7672
headers that do not have one explicitly defined (using the
77-
[Attribute List](attr_list.html) extension).
73+
[Attribute List](attr_list.md) extension).
7874

7975
>>> text = '''
8076
... # Some Header
@@ -103,7 +99,7 @@ The following options are provided to configure the output:
10399
Using with Meta-Data
104100
--------------------
105101

106-
The HeaderId extension also supports the [Meta-Data](meta_data.html) extension.
102+
The HeaderId extension also supports the [Meta-Data](meta_data.md) extension.
107103
Please see the documentation for that extension for specifics. The supported
108104
meta-data keywords are:
109105

docs/extensions/index.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,4 @@
1-
title: Extensions
2-
prev_title: Command Line
3-
prev_url: ../cli.html
4-
next_title: Extra Extension
5-
next_url: extra.html
6-
1+
title: Extensions
72

83
Available Extensions
94
====================

docs/extensions/meta_data.txt renamed to docs/extensions/meta_data.md

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
1-
title: Meta-Data Extension
2-
prev_title: HeaderId Extension
3-
prev_url: header_id.html
4-
next_title: New Line to Break Extension
5-
next_url: nl2br.html
1+
title: Meta-Data Extension
62

73
Meta-Data
84
=========
@@ -59,8 +55,8 @@ by Markdown.
5955
Usage
6056
-----
6157

62-
See [Extensions](index.html) for general extension usage, specify `markdown.extensions.meta`
63-
as the name of the extension.
58+
See [Extensions](index.md) for general extension usage, specify
59+
`markdown.extensions.meta` as the name of the extension.
6460

6561
Accessing the Meta-Data
6662
-----------------------
@@ -101,10 +97,10 @@ Compatible Extensions
10197
The following extensions are currently known to work with the Meta-Data
10298
extension. The keywords they are known to support are also listed.
10399

104-
* [HeaderId](header_id.html)
100+
* [HeaderId](header_id.md)
105101
* `header_level`
106102
* `header_forceid`
107-
* [WikiLinks](wikilinks.html)
103+
* [WikiLinks](wikilinks.md)
108104
* `wiki_base_url`
109105
* `wiki_end_url`
110106
* `wiki_html_class`

docs/extensions/nl2br.txt renamed to docs/extensions/nl2br.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
1-
title: New Line to Break Extension
2-
prev_title: Meta-Data Extension
3-
prev_url: meta_data.html
4-
next_title: Sane Lists Extension
5-
next_url: sane_lists.html
1+
title: New Line to Break Extension
62

73
New-Line-to-Break Extension
84
===========================
@@ -31,7 +27,7 @@ Example
3127
Usage
3228
-----
3329

34-
See [Extensions](index.html) for general extension usage, specify `markdown.extensions.nl2br`
35-
as the name of the extension.
30+
See [Extensions](index.md) for general extension usage, specify
31+
`markdown.extensions.nl2br` as the name of the extension.
3632

3733
This extension does not accept any special configuration options.

docs/extensions/sane_lists.txt renamed to docs/extensions/sane_lists.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
1-
title: Sane Lists Extension
2-
prev_title: New Line to Break Extension
3-
prev_url: nl2br.html
4-
next_title: SmartyPants Extension
5-
next_url: smarty.html
1+
title: Sane Lists Extension
62

73
Sane Lists
84
==========
@@ -67,7 +63,7 @@ In all other ways, Sane Lists should behave as normal Markdown lists.
6763
Usage
6864
-----
6965

70-
See [Extensions](index.html) for general extension usage, specify `markdown.extensions.sane_lists`
71-
as the name of the extension.
66+
See [Extensions](index.md) for general extension usage, specify
67+
`markdown.extensions.sane_lists` as the name of the extension.
7268

7369
This extension does not accept any special configuration options.

docs/extensions/smart_strong.txt renamed to docs/extensions/smart_strong.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
1-
title: Smart Strong Extension
2-
prev_title: Tables Extension
3-
prev_url: tables.html
4-
next_title: Admonition Extension
5-
next_url: admonition.html
1+
title: Smart Strong Extension
62

73
Smart_Strong
84
============
@@ -35,7 +31,7 @@ Example
3531
Usage
3632
-----
3733

38-
See [Extensions](index.html) for general extension usage, specify `markdown.extensions.smart_strong`
39-
as the name of the extension.
34+
See [Extensions](index.md) for general extension usage, specify
35+
`markdown.extensions.smart_strong` as the name of the extension.
4036

4137
This extension does not accept any special configuration options.

docs/extensions/smarty.txt renamed to docs/extensions/smarty.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
11
title: SmartyPants Extension
2-
prev_title: Sane Lists Extension
3-
prev_url: sane_lists.html
4-
next_title: Table of Contents Extension
5-
next_url: toc.html
62

73
SmartyPants
84
===========
@@ -55,10 +51,10 @@ the German language:
5551
Usage
5652
-----
5753

58-
See [Extensions](index.html) for general extension usage, specify
54+
See [Extensions](index.md) for general extension usage, specify
5955
`markdown.extensions.smarty` as the name of the extension.
6056

61-
See the [Library Reference](../reference.html#extensions) for information about
57+
See the [Library Reference](../reference.md#extensions) for information about
6258
configuring extensions.
6359

6460
The following options are provided to configure the output:

docs/extensions/tables.txt renamed to docs/extensions/tables.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
1-
title: Tables Extension
2-
prev_title: Footnotes Extension
3-
prev_url: footnotes.html
4-
next_title: Smart Strong Extension
5-
next_url: smart_strong.html
1+
title: Tables Extension
62

73
Tables
84
======
@@ -52,7 +48,7 @@ will be rendered as:
5248
Usage
5349
-----
5450

55-
See [Extensions](index.html) for general extension usage, specify `markdown.extensions.tables`
56-
as the name of the extension.
51+
See [Extensions](index.md) for general extension usage, specify
52+
`markdown.extensions.tables` as the name of the extension.
5753

5854
This extension does not accept any special configuration options.

0 commit comments

Comments
 (0)