From b941beb7973025d359f3e7839a5b99ea7f62c534 Mon Sep 17 00:00:00 2001 From: Waylan Limberg Date: Sat, 9 Aug 2008 22:28:45 -0400 Subject: Reorganized docs. Added an AUTHORS and INSTALL files. INSTALL is incomplete. --- README.html | 91 ------------------------------------------------------------- 1 file changed, 91 deletions(-) delete mode 100644 README.html (limited to 'README.html') diff --git a/README.html b/README.html deleted file mode 100644 index 6d94e8e..0000000 --- a/README.html +++ /dev/null @@ -1,91 +0,0 @@ -

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

- -

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 -- cgit v1.2.3