Changelog

Possible log types:

[added] for new features.
[changed] for changes in existing functionality.
[deprecated] for once-stable features removed in upcoming releases.
[removed] for deprecated features removed in this release.
[fixed] for any bug fixes.
[security] to invite users to upgrade in case of vulnerabilities.

0.17.1

[added] Add support for XHTML (for the cases where it doesn't quite behave like HTML).

0.17.0

[changed] Split html2text example into html2text-cli crate
[fixed] A possible panic when syntax-highlighting
[changed] Update html5ever to 0.39.0

0.16.7

[added] Support <b> tags as bold (thanks amir)
[changed] Update html5ever to 0.38.0 (thanks mtorromeo)

0.16.6

[changed] Update html5ever and tendril dependencies.

0.16.5

[fixed] Fix a subtract with underflow with rowspans and empty rows (thanks mdierksen)

0.16.4

[fixed] Further fix for RcDom::serialize() when there is a <doctype>.

0.16.3

[fixed] RcDom::serialize() panicked.
[changed] Bumped html5ever dependency
[fixed] Fixed a subtraction underflow in the html2term example.

0.16.2

[fixed] Removed spurious dbg!() accidentally left in.

0.16.1

[added] Add Config::empty_img_mode() to configure how images with no alt text are handled.

0.16.0

[changed] Updated MSRV to 1.85.
[fixed] Fix a panic in debug mode (subtraction underflow) with some table/rowspan edge cases (thanks mtorromeo)

0.15.5

[fixed] Fix an assertion and some missing styles with rowspan cells in rich mode.

0.15.4

[added] Support handling rowspan in tables.

0.15.3

[fixed] Parse <noscript> tags as if scripting is disabled (thanks craigchiang)
[fixed] Treat inline <svg> as images (thanks craigchiang)

0.15.2

[fixed] Fix whitespace-only tables being shown as "─" (thanks fuelen)
[fixed] Fix wrapping with non-breaking spaces, zero-width spaces, and some similar equivalents.

0.15.1

[added] CSS: Support basic attribute selectors (div[attr="bar"]).
[changed] Various improvements to syntax highlighting:
- It uses the priority of the x-syntax rule.
- Now supported on non-<pre> elements.
- No longer strips contained tags when highlighting
- Compatible with display: x-raw-dom extension (e.g. to colour the HTML)
[fixed] With pad_block_width enabled, do a better job of padding blocks. In particular, the padding gets the block's background colour (when CSS etc. are being used).

0.15.0

[added] Syntax highlighting support for <pre> blocks (Config::register_highlighter and CSS x-syntax: foo)
[changed] CSS extensions (until now display: x-raw-dom, and only if the css_ext Cargo feature is enabled) are now only available in agent and user CSS. This is a breaking change, but is not likely to affect many users.

0.14.4

[added] RcDom::serialize, and expose a few more of the RcDom types.
[added] Online demo page

0.14.3

[changed] Updated dependencies, including html5ever 0.31.

0.14.2

[fixed] An issue with multiple verions of markup5ever being included. (thanks anna-hope)

0.14.1

[fixed] An issue with FragmentStarts being lost (thanks toiletbril)
[fixed] An infinite loop if tabs inside <pre> wrapped past the width (thanks nshp)

0.14.0

[changed] Various small refactors (thanks sftse)
[changed] Config::rich() no longer includes decorations around <em> etc. - use Config::rich().do_decorate() to get the old behaviour.
[fixed] Remove unnecessary empty lines at the start of lists (thanks russellbanks)
[added] New CSS support: ::before/::after and content: "string", which is now used for simple decorations. With CSS enabled, this allows for customising the display of <em>foo</em> without writing a decorator.
[added] Add support for <h5> and <h6> (thanks noahbaculi)
[changed] Link footnotes are now configurable independently of the decorator, and on by default for config::plain() but can be enabled or disabled with config.link_footnotes(true/false). The footnote references (e.g. [1]) are added in the main renderer, and the actual footnotes are written in a default implementation of TextDecorator::finalise() so can be customised.

0.13.6

[fixed] Fixed issue parsing CSS rules with known rules but unknown values, which caused parsing to stop instead of just skipping the unkown rule.

0.13.5

[added] CSS support for :nth-child() (not yet with the of foo).
[added] Non-standard display: x-raw-dom for debugging (with css_ext feature flag).
[fixed] An issue which could (apparently rarely) miss out some output depending on wrapping
[fixed] CSS parsing stopped when it hit an at-rule.
[added] Add --show-css option to html2text example for debugging what rules were parsed.
[added] Add poor-man's inspect mode to html2term - I to enable/disable, and arrows to navigate around the DOM. Implemented using :nth-child and x-raw-dom.

0.13.4

[fixed] Fix a debug assertion from a double-counted length increment (thanks JadedBlueeyes).

0.13.3

[fixed] Handle some obsolete bgcolor=... attributes.
[added] html2text example has --show-render to help debugging render issues.
[changed] Some error handling and other tidyups (thanks sftse)

0.13.2

[fixed] Fixed errors when building with Rust 1.72.

0.13.1

[added] html2text now has --show-dom
[fixed] Support background CSS property (for colour)
[fixed] Some edge cases with CSS styles on whitespace

0.13.0

[added] Support CSS white-space: pre-wrap (and normal, pre).

0.13.0-alpha.2

[changed] Updated html5ever and markup5ever crate versions. This has meant updating the MSRV, which is now set to 1.72.
[fixed] Add Config::no_link_wrapping() (thanks JadeBlueEyes)
[fixed] Fix panic with empty table inside a list (thanks sftse)
[changed] Top level convenience functions (from_read etc.) now return Result<..> instead of panicking (thanks sftse)
[fixed] Fix panic with very large HTML colspan (thanks pycui)
[changed] CSS updates:
- Separate user agent, author, and user CSS layers
- Improve the style precedence between layers and implement specificity.

0.13.0-alpha.1

[fixed] Table rows with colours would disappear. (thanks tkapias)

0.13.0-alpha.0

[changed] Replaced LightningCSS with a smaller CSS parser. There is a chance that some CSS edge cases which no longer work; if so this would be a bug.
[removed] Some previously pub items and methods which are either internal implementation details or considered redundant have been removed or made private (thanks sftse). Please open an issue for anything removed that was being used.

Of note, RenderTree::render_plain() and RenderTree::render_rich() have been removed. Replace code like:
```
let text = html2text::parse(html)?
    .render_plain(80)?
    .into_string()?;
```
with:
```
let text = html2text::config::plain()
    .render_to_string(html2text::parse(html)?)?
```
[changed] Some names moved out of text_renderer module, so some use statements may need updating.
[changed] Replace some unwrap() with improved patterns (thanks sftse).
[changed] Updated some dependencies

0.12.5

[changed] Updated some dependencies
[added] The html2text example now has --ignore-css-colour, which ignores CSS colour information but still uses display: none, for example.
[added] The html2text example now has --only-css option, to not use default colours when CSS colours are being used.
[fixed] Make the dummy dashmap depenency optional so it's not included unnecessarily when CSS isn't enabled (thanks xmakro)

0.12.4

[changed] Update the previous max-height: 0 to also look at height: 0 and require overflow: hidden as well. This helps with a hack some e-mail senders use for e-mail previews. (thanks tkapias)

0.12.3

[changed] Treat max-height: 0 as if it's display: none when CSS is enabled. This helps with a hack some e-mail senders use for e-mail previews. (thanks tkapias)

0.12.2

[changed] Bump version of lightningcss dependency to fix build failures.

0.12.1

[fixed] Fix a case where Err(TooNarrow) was returned unnecessarily. (thanks sftse)
[added] Add new rendering options Config::raw_mode() and Config::no_table_borders() (thanks sftse)
[changed] Formatting, clippy and other tidy-ups (thanks sftse)
[changed] Cargo fmt now enforced in CI

0.12.0

[changed] Updated termion dev-dependency
[added] Support <sup> HTML elements
[added] Export RcDom publically. It was already returned by a pub function.
[added] Update handling of width overflow: With Config::allow_width_overflow(), prefer returning output wider than requested, instead of returning Err(TooNarrow). Config::min_wrap_width() sets the minimum text wrap width (default 3). The minimum width (before overflow or TooNarrow) is now handled more cleanly.
[added] CSS: use color/bgcolor attributes on elements.

0.11.0

[fixed] CSS: rules marked !important were ignored.
[changed] html_trace feature now uses the log crate.
[changed] Bumped MSRV to 1.63 (matching Debian stable) due to some dependencies.

0.10.3

[fixed] A panic on some unlucky text wrapping coincidences.
[fixed] Use dep:backtrace in Cargo.toml to avoid implicit feature.

0.10.2

[fixed] CSS: Ignore transparent colours.

0.10.1

[fixed] max_width was not working with some render methods.

0.10.0

[added] Simple support for <i>, <ins>, and <del> (thanks sgtatham)
[added] Added background-color support
[fixed] CSS support didn't work in some places, such as <td> elements.
[added] Add support for style attributes.
[added] Styles apply to table borders
[changed] Update some dependencies
[fixed] Fix a few places which caused excess blank lines or empty tables

0.9.4

[changed] Updated the termion dev-dependency to 2.0.

0.9.3

[changed] Added cargo categories and update to 2021 edition.

0.9.2

[fixed] CSS didn't work inside <ul> or <ol>.
[added] Add methods to get and use the intermediate HTML DOM and RenderTree from Config.
[fixed] Removed some clones which are no longer necessary now that Box works.

0.9.1

[fixed] Various documentation issues (thanks sgtatham)
[changed] CSS color rules now work for elements other than span.

0.9.0

[changed] Config::add_css now returns Result instead of panicking on CSS parse errors. Errors from parsing document CSS are ignored.
[added] Support <font color=...> when CSS is enabled.
[added] Config::max_wrap_width() to wrap text to a norrower width than the overal size available.
[added] Add --wrap-width and --css options to html2text example.

0.8.0

[added] CSS: Support more extensive selectors
[changed] CSS handling defaults to off; use Config::use_doc_css() or Config::add_css to use CSS.

0.7.1

[added] Now recognised CSS display:none
[added] Can now add extra CSS rules via Config::add_css.
[changed] StyleData::coloured is no longer public.

0.7.0

[changed] Remove some noisy stderr output when encoutering control chars (thanks sftse)
[added] A builder-based config API.
[changed] Updated MSRV to 1.60
[fixed] Fixed #88: panic when a width of zero passed in (thanks bingen13)
[fixed] Fixed #90: Fixed a divide-by-zero panic with colspan=0 (thanks mtorromeo)
[added] Add very basic CSS colour support (under the css feature flag)
[changed] Removed ansi_colours feature (from_read_coloured is always available)
[changed] Overhauled error handling. Internally (and in the lower level API) errors (mainly "TooNarrow") are passed around with Result. Fixed some panics and infinite loops. (Thanks WIZeaz for fuzzing)

0.6.0

[changed] Improve layout of tables thanks to sftse:
- Table column size estimates have been improved when the source HTML has a lot of unnecessary whitespace.
- Move the URL footnotes out to the top level, also improving layout of tables containing links.
[changed] Some APIs have slightly changed as part of the table improvements, though most users should not be affeted.

0.5.1

[fixed] Some tables were rendered too wide.

0.5.0

[changed] Rich Image annotations now include the src attirbute (thanks spencerwi).

0.4.5

[fixed] Preserve empty lines in pre blocks (thanks kpagacz).

0.4.4

[fixed] Fix some panics when enumerated lists are in tables (thanks sfts).
[fixed] Impove table size estimation to include links.

0.4.3

[changed] MSRV is now 1.56.
[fixed] Fix some panics when very large widths are used with tables.

0.4.2

[changed] Moved the rcdom module directly into src/

0.4.1 (unpublished)

[changed] rcdom now vendored as a module.

0.4.0 (unpublished)

[changed] Update html5ever to v0.26.
[changed] MSRV is now 1.49.

0.3.1

[changed] Update the build badges to reflect the updated CI configuration.

0.3.0

[added] New experimental from_read_coloured() (under ansi_colours feature).
[added] Add into_tagged_strings and tagged_strings methods to TaggedLine (thanks Robin Krahl)
[added] Add width method to TaggedString (thanks Robin Krahl)
[changed] Keep annotations in TextRenderer::into_lines (thanks Robin Krahl)
[fixed] Add colon to reference style link (thanks zakaluka)
[added] Allow text decorators to customise block prefix strings (thanks SardineFish)
[fixed] Fixed some problems rendering some complicated tables, including a panic and near-infinite loops.
[changed] Tables which are too wide to possibly render in the given width are now arranged vertically instead (with ///) lines.
[changed] A number of small table rendering improvements.
[changed] MSRV is now 1.41.

0.2.1

[added] New entry points - split HTML parsing from rendering the output, thanks Robin Krahl.
[fixed] Decorators weren't being used for preformatted text.

0.2.0

[added] Support <s> strikeout text.

0.1.14 (2020-08-07)

[fixed] A table with an id attribute on <tbody> would be hidden.

0.1.13 (2020-07-21)

[changed] Run cargo fmt (thanks crunchyjesus)
[added] CHANGELOG.md
[fixed] Some text near a fragment start (id="foo" attribute) could be lost if it needed breaking across lines.
[added] Experimentally add dependabot configuration.

FilesExpand file tree

CHANGELOG.md

Latest commit

History

CHANGELOG.md

File metadata and controls

Changelog

0.17.1

0.17.0

0.16.7

0.16.6

0.16.5

0.16.4

0.16.3

0.16.2

0.16.1

0.16.0

0.15.5

0.15.4

0.15.3

0.15.2

0.15.1

0.15.0

0.14.4

0.14.3

0.14.2

0.14.1

0.14.0

0.13.6

0.13.5

0.13.4

0.13.3

0.13.2

0.13.1

0.13.0

0.13.0-alpha.2

0.13.0-alpha.1

0.13.0-alpha.0

0.12.5

0.12.4

0.12.3

0.12.2

0.12.1

0.12.0

0.11.0

0.10.3

0.10.2

0.10.1

0.10.0

0.9.4

0.9.3

0.9.2

0.9.1

0.9.0

0.8.0

0.7.1

0.7.0

0.6.0

0.5.1

0.5.0

0.4.5

0.4.4

0.4.3

0.4.2

0.4.1 (unpublished)

0.4.0 (unpublished)

0.3.1

0.3.0

0.2.1

0.2.0

0.1.14 (2020-08-07)

0.1.13 (2020-07-21)