@@ 9,8 9,9 @@ It differs from other packages in these
- Pure Python, no dependencies
- High quality, well tested code
- Permissive license (Apache)
-- Renders the HTML to text suitable for an text/plain email body (doesn't
- convert to a structured text format such as markdown).
+- Renders the HTML to text suitable for an text/plain email body (it doesn't
+ aim to convert to a structured text format like markdown, but rather at giving
+ a readable text-only representation of the rendered HTML).
Usage::
@@ 27,3 28,17 @@ Usage::
This is a paragraph
This is another paragraph
+
+
+htmltextconvert handles the following HTML tags:
+
+- Character entity references (``&name;``, ``&#nnnn;``, ``&#xhhhh``)
+- Unordered lists (``<ul>``)
+- Ordered lists (``<ol>``)
+- Paragraphs (``<p>``)
+- Block quotes (``<blockquote>``)
+- Linebreaks (``<br>``)
+- Links (``<a href="…">``)
+- Bold (``<strong>``)
+- Italic (``<em>``)
+- Code (``<code>``)