https://github.com/usox/html2text
A hacklang script to convert HTML into a plain text format
https://github.com/usox/html2text
converter hacklang hhvm html htmltotext mail text
Last synced: 4 months ago
JSON representation
A hacklang script to convert HTML into a plain text format
- Host: GitHub
- URL: https://github.com/usox/html2text
- Owner: usox
- License: mit
- Created: 2019-02-27T10:36:14.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-02-27T11:28:59.000Z (over 6 years ago)
- Last Synced: 2025-02-08T05:44:40.355Z (8 months ago)
- Topics: converter, hacklang, hhvm, html, htmltotext, mail, text
- Language: HTML
- Size: 36.1 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
html2text [](https://travis-ci.org/usox/html2text) [](https://packagist.org/packages/usox/html2text)
=========
html2text is a very simple script that uses DOM methods to convert HTML into a format similar to what would be
rendered by a browser - perfect for places where you need a quick text representation. For example:
```html
Ignored Title
Hello, World!
This is some e-mail content.
Even though it has whitespace and newlines, the e-mail converter
will handle it correctly.
Even mismatched tags.
A div
Another div
A divwithin a div
```
Will be converted into:
```text
Hello, World!
This is some e-mail content. Even though it has whitespace and newlines, the e-mail converter will handle it correctly.
Even mismatched tags.
A div
Another div
A div
within a div
[A link](http://foo.com)
```
## Installing
You can use [Composer](http://getcomposer.org/) to add the [package](https://packagist.org/packages/soundasleep/html2text) to your project:
```json
{
"require": {
"usox/html2text": "^1"
}
}
```
And then use it quite simply:
```php
$converter = new \Usox\Html2Text()
$text = $converter->convert($html);
```
You can also include the supplied `html2text.php` and use `$text = convert_html_to_text($html);` instead.
### Options
| Option | Default | Description |
|--------|---------|-------------|
| **ignore_errors** | `false` | Set to `true` to ignore any XML parsing errors/warnings. |
| **drop_links** | `false` | Set to `true` to not render links as `[http://foo.com](My Link)`, but rather just `My Link`. |
Pass along options as a second argument to `convert`, for example:
```php
$html = 'some fine html';
$options = dict[
'ignore_errors' => true,
// other options go here
];
$converter = new \Usox\Html2Text()
echo $converter->convert($html, $options);
```
## Tests
Some very basic tests are provided in the `tests/` directory. Run them with `composer install && vendor/bin/hacktest tests`.
## License
`html2text` is [licensed under MIT](LICENSE.md), making it suitable for both Eclipse and GPL projects.
## Other versions
This is a port of the php version found [here](https://github.com/soundasleep/html2text).