diff options
author | Waylan Limberg <waylan@gmail.com> | 2013-01-10 11:07:43 -0500 |
---|---|---|
committer | Waylan Limberg <waylan@gmail.com> | 2013-01-10 11:07:43 -0500 |
commit | 6c49938bad9b26f00acd6fc74f399a7ee4d87701 (patch) | |
tree | 014e65f1fff212ed3ff7396df594066b9f3d2888 /docs | |
parent | cd05e3fa90eaa9b6079495a690f37ca0909c833e (diff) | |
download | markdown-6c49938bad9b26f00acd6fc74f399a7ee4d87701.tar.gz markdown-6c49938bad9b26f00acd6fc74f399a7ee4d87701.tar.bz2 markdown-6c49938bad9b26f00acd6fc74f399a7ee4d87701.zip |
Added a "goals" section to the docs.
Now, when we receive feature requests that don't fit within the
scope of the Python-Markdown project, we have something to point
to in response.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/index.txt | 17 |
1 files changed, 15 insertions, 2 deletions
diff --git a/docs/index.txt b/docs/index.txt index e1433d5..36b05b5 100644 --- a/docs/index.txt +++ b/docs/index.txt @@ -15,6 +15,18 @@ for the syntax rules. See the [installation instructions](install.html) to get started. +Goals +----- + +The Python-Markdown project is developed with the following goals in mind: + +* Maintain a python implementation of markdown that follows the + [syntax rules](http://daringfireball.net/projects/markdown/syntax) + and the behavior of the original (markdown.pl) implementation as reasonably + as possible (see [differences](#differences) for a few exceptions). +* Provide an [Extension API](extensions/api.html) which allows any behaviors of + the parser to be overridden/changed. + Features -------- @@ -55,8 +67,9 @@ Differences ----------- While Python-Markdown strives to fully implement markdown as described in the -syntax rules, the rules can be interpreted in different ways and different -implementations occasionally vary in their behavior (see the +[syntax rules](http://daringfireball.net/projects/markdown/syntax), the rules +can be interpreted in different ways and different implementations +occasionally vary in their behavior (see the [Babelmark FAQ](http://johnmacfarlane.net/babelmark2/faq.html#what-are-some-examples-of-interesting-divergences-between-implementations) for some examples). Known and intentional differences found in Python-Markdown are summarized below: |