aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/cli.md (renamed from docs/command_line.md)6
-rw-r--r--docs/extensions/api.md (renamed from docs/writing_extensions.md)10
-rw-r--r--docs/extensions/extra.md2
-rw-r--r--docs/extensions/index.md14
-rw-r--r--docs/extensions/wikilinks.md2
-rw-r--r--docs/index.md8
-rw-r--r--docs/install.md2
-rw-r--r--docs/reference.md (renamed from docs/using_as_module.md)5
-rw-r--r--docs/test_suite.md2
9 files changed, 25 insertions, 26 deletions
diff --git a/docs/command_line.md b/docs/cli.md
index c597c52..6048ecc 100644
--- a/docs/command_line.md
+++ b/docs/cli.md
@@ -1,6 +1,6 @@
title: Command Line
prev_title: Library Reference
-prev_url: using_as_module.html
+prev_url: reference.html
next_title: Extensions
next_url: extensions/index.html
@@ -97,8 +97,8 @@ Using Extensions
----------------
For an extension to be run from the command line it must be provided in a module
-which should be in your python path (see [writing_extensions](writing_extensions.html)
-for details). It can then be invoked by the name of that module:
+on your python path (see the [Extension API](extensions/api.html) for details).
+It can then be invoked by the name of that module:
$ markdown_py -x footnotes text_with_footnotes.txt > output.html
diff --git a/docs/writing_extensions.md b/docs/extensions/api.md
index 1e40019..c27abf0 100644
--- a/docs/writing_extensions.md
+++ b/docs/extensions/api.md
@@ -1,8 +1,8 @@
title: Extensions API
prev_title: Wikilinks Extension
-prev_url: extensions/wikilinks.html
+prev_url: wikilinks.html
next_title: Test Suite
-next_url: test_suite.html
+next_url: ../test_suite.html
Writing Extensions for Python-Markdown
======================================
@@ -616,6 +616,6 @@ than one residing in a module.
[Config Settings]: #configsettings
[makeExtension]: #makeextension
[ElementTree]: http://effbot.org/zone/element-index.htm
-[Available Extensions]: extensions/
-[Footnotes]: extensions/footnotes.html
-[Definition Lists]: extensions/definition_lists.html
+[Available Extensions]: index.html
+[Footnotes]: footnotes.html
+[Definition Lists]: definition_lists.html
diff --git a/docs/extensions/extra.md b/docs/extensions/extra.md
index 998a200..adafe07 100644
--- a/docs/extensions/extra.md
+++ b/docs/extensions/extra.md
@@ -45,4 +45,4 @@ of those extensions are not part of PHP Markdown Extra, and
therefore, not part of Python-Markdown Extra. If you really would
like Extra to include additional extensions, we suggest creating
your own clone of Extra under a different name
-(see [Writing Extensions](../writing_extensions.html)).
+(see the [Extension API](api.html)).
diff --git a/docs/extensions/index.md b/docs/extensions/index.md
index b09b2c2..293d1b0 100644
--- a/docs/extensions/index.md
+++ b/docs/extensions/index.md
@@ -1,6 +1,6 @@
title: Extensions
prev_title: Command Line
-prev_url: ../command_line.html
+prev_url: ../cli.html
next_title: Extra Extension
next_url: extra.html
@@ -13,14 +13,12 @@ to change and/or extend the behavior of the parser without having to edit the
actual source files.
To use an extension, pass it's name to markdown with the `extensions` keyword.
-See [Using Markdown as a Python Library](../using_as_module.html) for more
-details.
+See the [Library Reference](../reference.html) for more details.
markdown.markdown(some_text, extensions=['extra', 'nl2br'])
-From the command line, specify an extension with the `-x` option.
-See [Using Python-Markdown on the Command Line](../command_line.html) or use the
-`--help` option for more details.
+From the command line, specify an extension with the `-x` option. See the
+[Command Line docs](../cli.html) or use the `--help` option for more details.
python -m markdown -x extra input.txt > output.html
@@ -56,10 +54,10 @@ Third Party Extensions
Various individuals and/or organizations have developed extensions which they
have made available to the public. A [list of third party
-extensions](http://freewisdom.org/projects/python-markdown/Available_Extensions)
+extensions](https://github.com/waylan/Python-Markdown/wiki/Third-Party-Extensions)
is maintained on the wiki for your convenience. The Python-Markdown team
offers no official support for these extensions. Please see the developer of
each extension for support.
If you would like to write your own extensions, see the
-[Extensions API](../writing_extensions.html) for details.
+[Extensions API](api.html) for details.
diff --git a/docs/extensions/wikilinks.md b/docs/extensions/wikilinks.md
index 22baf9f..522e7c5 100644
--- a/docs/extensions/wikilinks.md
+++ b/docs/extensions/wikilinks.md
@@ -2,7 +2,7 @@ title: Wikilinks Extension
prev_title: Table of Contents Extension
prev_url: toc.html
next_title: Extension API
-next_url: ../writing_extensions.html
+next_url: api.html
WikiLinks
=========
diff --git a/docs/index.md b/docs/index.md
index 1c6ca5a..fb48399 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -30,13 +30,13 @@ features:
Python-Markdown defaults to ignoring middle-word emphasis. In other words,
`some_long_filename.txt` will not become `some<em>long</em>filename.txt`.
This can be switched off if desired. See the
- [Library Reference](using_as_module.html) for details.
+ [Library Reference](reference.html) for details.
* __Extensions__
- Various [extensions](extensions/) are provided (including
+ Various [extensions](extensions/index.html) are provided (including
[extra](extensions/extra.html)) to expand the base syntax. Additionally,
- a public [Extension API](writing_extensions.html) is available to write
+ a public [Extension API](extensions/api.html) is available to write
your own extensions.
* __Output Formats__
@@ -52,7 +52,7 @@ features:
* __Command Line Interface__
In addition to being a Python Library, a
- [command line script](command_line.html) is available for your convenience.
+ [command line script](cli.html) is available for your convenience.
Support
-------
diff --git a/docs/install.md b/docs/install.md
index cc2a10d..a7e7ff0 100644
--- a/docs/install.md
+++ b/docs/install.md
@@ -2,7 +2,7 @@ title: Installation
prev_title: Summary
prev_url: index.html
next_title: Library Reference
-next_url: using_as_module.html
+next_url: reference.html
Installing Python-Markdown
==========================
diff --git a/docs/using_as_module.md b/docs/reference.md
index 72c4965..16735c7 100644
--- a/docs/using_as_module.md
+++ b/docs/reference.md
@@ -2,7 +2,7 @@ title: Library Reference
prev_title: Installation
prev_url: install.html
next_title: Command Line
-next_url: command_line.html
+next_url: cli.html
Using Markdown as a Python Library
@@ -57,7 +57,8 @@ The following options are available on the `markdown.markdown` function:
Python-Markdown provides an API for third parties to write extensions to
the parser adding their own additions or changes to the syntax. A few
commonly used extensions are shipped with the markdown library. See
- the [extension documentation](extensions) for a list of available extensions.
+ the [extension documentation](extensions/index.html) for a list of
+ available extensions.
The list of extensions may contain instances of extensions or stings of
extension names. If an extension name is provided as a string, the
diff --git a/docs/test_suite.md b/docs/test_suite.md
index c1034b6..cf9353c 100644
--- a/docs/test_suite.md
+++ b/docs/test_suite.md
@@ -1,6 +1,6 @@
title: Test Suite
prev_title: Extension API
-prev_url: writing_extensions.html
+prev_url: extensions/api.html
# Test Suite