Skip to content

renesugar/html2txt

Repository files navigation

html2txt

html2txt converts HTML to markdown.

Usage

Import the module.

from html2txt import converters

Call the Html2Markdown converter on HTML text to convert it to markdown.

markdown = converters.Html2Markdown().convert(html)

Run converter for unit testing

> cd html2txt/converters
> python3 -B html2markdown.py --path path-to-html-directory

Tests

Create Virtual Environment

> cd html2txt

> python3 -m venv venv

> source ./venv/bin/activate

Making Tests

The Commonmark and Breakdance tests were written for converting markdown to HTML so many tests fail with differences of whitespace and choices of markdown representation.

Breakdance is used by Dillinger, a markdown editor.

> cd html2txt/tests

> python3 -B ./config/mkhtml2txt.py --path .

> python3 -B ./config/mkcommonmark.py --path .

> python3 -B ./config/mkbreakdance.py --path .

> python3 -B ./config/mksvgweb.py --path .

> python3 -B ./config/mkmathml.py --path .

Running Tests

> pytest -vv

Releases

No releases published

Packages

No packages published

Languages