diff options
| author | Waylan Limberg <waylan@gmail.com> | 2012-03-07 09:35:40 -0500 |
|---|---|---|
| committer | Waylan Limberg <waylan@gmail.com> | 2012-03-07 09:35:40 -0500 |
| commit | ec46692cf5c4d5e22950bc8e7d14cb0ec327fb87 (patch) | |
| tree | 9c1b9c5025948204e415a21938469bf50bbae754 /docs/extensions/html_tidy.txt | |
| parent | 9fd4a5f1600c96406ad0fb86b1a8287d525972ac (diff) | |
| download | markdown-ec46692cf5c4d5e22950bc8e7d14cb0ec327fb87.tar.gz markdown-ec46692cf5c4d5e22950bc8e7d14cb0ec327fb87.tar.bz2 markdown-ec46692cf5c4d5e22950bc8e7d14cb0ec327fb87.zip | |
Rename docs/*.md => docs/*.txt
The documentation uses features of Python-Markdown that are not supported on
GitHub and it's better to get a source view of the docs anyway. For example,
that way comments and bug reports can reference a specific line of a file.
Of course, it makes sense for Github to render the README, so that is left
with the `.md` file extension.
Diffstat (limited to 'docs/extensions/html_tidy.txt')
| -rw-r--r-- | docs/extensions/html_tidy.txt | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/docs/extensions/html_tidy.txt b/docs/extensions/html_tidy.txt new file mode 100644 index 0000000..391349b --- /dev/null +++ b/docs/extensions/html_tidy.txt @@ -0,0 +1,34 @@ +title: HTML Tidy Extension +prev_title: CodeHilite Extension +prev_url: code_hilite.html +next_title: HeaderId Extension +next_url: header_id.html + +HTML Tidy +========= + +Runs [HTML Tidy][] on the output of Python-Markdown using the [uTidylib][] +Python wrapper. Both libtidy and uTidylib must be installed on your system. + +This extension is available in the standard Markdown library since version 2.0. + +[HTML Tidy]: http://tidy.sourceforge.net/ +[uTidylib]: http://utidylib.berlios.de/ + +Note than any Tidy [options][] can be passed in as [extension configs][]. So, +for example, to output HTML rather than XHTML, set ``output_xhtml=0``. To +indent the output, set ``indent=auto`` and to have Tidy wrap the output in +``<html>`` and ``<body>`` tags, set ``show_body_only=0``. See Tidy's +[options][] for a full list of the available options. The defaults are set to +most closely match Markdowns defaults with the exception that you get much +better pretty-printing. + +[options]: http://tidy.sourceforge.net/docs/quickref.html +[extension configs]: ../reference.html#extension_configs + +Note that options set in this extension will override most any other settings +passed on to Markdown (such as "output_format"). Unlike Markdown, this extension +will also treat raw HTML no different than that output by Markdown. In other +words, it may munge a document authors carefully crafted HTML. Of course, it +may also transform poorly formed raw HTML into nice, valid HTML. Take these +things into consideration when electing to use this extension. |