From 32eeea883fa316fbcff49b790c269b2e35083619 Mon Sep 17 00:00:00 2001 From: Waylan Limberg Date: Wed, 15 Oct 2008 12:07:50 -0400 Subject: Updated README to ackowledge other recently added docs and not repeat them. --- docs/README.html | 97 ++++++-------------------------------------------------- 1 file changed, 9 insertions(+), 88 deletions(-) (limited to 'docs/README.html') diff --git a/docs/README.html b/docs/README.html index 6d94e8e..49e3b07 100644 --- a/docs/README.html +++ b/docs/README.html @@ -1,91 +1,12 @@

Python-Markdown

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

- -

Installation

-

To install Python Markdown download the zip file and extract the - files. If you want to install markdown as a module into your python - tree, run sudo python setup.py install from a directory where you - unzip the files. -

- -

Command Line Usage

-

To use markdown.py from the command line, run it as -

-
python markdown.py <input_file>
-

or -

-
python markdown.py <input_file> > <output_file>
-

For more details, use the -h or --help options from the command line - or read the Command Line Docs available online. -

- -

Using as a Python Module

-

To use markdown as a module: -

-
import markdown
-html = markdown.markdown(your_text_string)
-

For more details see the Module Docs. -

- +It is almost completely compliant with the reference implementation, +though there are a few known issues. See Features for information +on what exactly is supported and what is not. Additional features are +supported by the Available Extensions.

+

Documentation

+

Installation and usage documentation is available in the docs/ directory +of the distribution and on the project website at +http://freewisdom.org/projects/python-markdown.

Support

-

You may ask for help and discuss various other issues on the mailing list and report bugs on the bug tracker. -

- -

Credits

- -

Other contributions: -

- - -

License

-

The code is dual-licensed under GPL and BSD License. Other - licensing arrangements can be discussed. -

\ No newline at end of file +

You may ask for help and discuss various other issues on the mailing list and report bugs on the bug tracker.

\ No newline at end of file -- cgit v1.2.3