CHANGELOG.md

Changelog

Notable changes to readability will be documented in this file.

The format is based on Keep a Changelog, and this project attempts to adhere to Semantic Versioning.

For the purposes of Semantic Versioning, the readability output object for a given input document is not considered a stable API. That is, minor version increments may change this output. Patch version increments will only do so in ways that are strict improvements (e.g. from empty strings or exceptions to something more reasonable).

[Unreleased]

• Add Parsely tags as a fallback metadata source
• Fix the case that jsonld parse process is ignored when context url include the trailing slash
• Fixed situations where short paragraphs of legitimate content would be excluded

[0.5.0] - 2023-12-15

• Add published time metadata
• Expanded comma detection to non-Latin commas
• Fix detection of elements hidden with style="visibility: hidden"

[0.4.4] - 2023-03-31

• Fixed undefined li_count variable breaking use of readability in Cloudflare workers

[0.4.3] - 2023-03-22

• Fixed aria-modal cookie dialogs interfering with readability
• Fixed lists of images not showing
• Updated type information for TypeScript
• Simplify script and noscript removal
• Updated dependencies
• Added allowedVideoRegex option to override the default

[0.4.2] - 2022-02-09

• Fix compatibility with DOM implementations where the childNodes property is not live (x2).
• Lazily-loaded image references will no longer use the alt attribute to find images.
• parse() provides the root element's lang attribute
• isProbablyReadable includes article tags
• Improvements to JSON-LD support
  • Continue parsing other JSON-LD elements until we find one we can support
  • Prefer using headline for article title

[0.4.1] - 2021-01-13

Added

• Typescript type definition file (.d.ts).

[0.4.0] - 2020-12-23

Added

• isProbablyReaderable can now take an optional options object to configure it, allowing you to specify the minimum content length, minimum score, and how to check if nodes are visible.

• Better support for deeply-nested content.

• Readability is now more likely to keep tables of content.

• Better support for content in <code> tags.

• Readability (finally) no longer throws away all <h1> tags.

Changed

• JSON-LD support for multiple authors was improved.

• Elements with roles menu, menubar, complementary, navigation, alert, alertdialog, dialog will all be removed.

[0.3.0] - 2020-08-05

The first version that was published on NPM.

Previously, we did not consistently version anything, nor did we publish to NPM.

At some point, we may wish to expand this changelog into the past.