| # Changelog |
| |
| Notable changes to readability will be documented in this file. |
| |
| The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), |
| and this project attempts to adhere to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). |
| |
| 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] |
| |
| ## [0.6.0] - 2025-03-03 |
| |
| - [Add Parsely tags as a fallback metadata source](https://github.com/mozilla/readability/pull/865) |
| - [Fix the case that jsonld parse process is ignored when context url include the trailing slash](https://github.com/mozilla/readability/pull/833) |
| - [Improve data table support](https://github.com/mozilla/readability/pull/858) |
| - [Fixed situations where short paragraphs of legitimate content would be excluded](https://github.com/mozilla/readability/pull/867) |
| - [Add an option to modify link density value](https://github.com/mozilla/readability/pull/874) |
| - [Byline metadata should lead to not deleting lookalike non-byline content](https://github.com/mozilla/readability/pull/869) |
| - [Avoid removing headers on gitlab](https://github.com/mozilla/readability/pull/885) |
| - [Improved HTML character unescaping](https://github.com/mozilla/readability/pull/896) |
| - Various performance improvements: [#894](https://github.com/mozilla/readability/pull/894), |
| [#892](https://github.com/mozilla/readability/pull/892), [#893](https://github.com/mozilla/readability/pull/893), |
| [#915](https://github.com/mozilla/readability/pull/915), |
| - [Fix broken JSONLD context handling](https://github.com/mozilla/readability/pull/902) |
| - [Include Jekyll footnotes in output](https://github.com/mozilla/readability/pull/907) |
| - [Handle schema.org context objects](https://github.com/mozilla/readability/pull/940) |
| - [Fix invalid attributes breaking parsing](https://github.com/mozilla/readability/pull/918) |
| - [Include article:author metadata](https://github.com/mozilla/readability/pull/942) |
| - [Handle itemprop=name for author metadata](https://github.com/mozilla/readability/pull/943) |
| - [Improve typescript definitions](https://github.com/mozilla/readability/pull/944) |
| - [Handle JSONLD Arrays](https://github.com/mozilla/readability/pull/947) |
| |
| ## [0.5.0] - 2023-12-15 |
| |
| - [Add published time metadata](https://github.com/mozilla/readability/pull/813) |
| - [Expanded comma detection to non-Latin commas](https://github.com/mozilla/readability/pull/796) |
| - [Fix detection of elements hidden with style="visibility: hidden"](https://github.com/mozilla/readability/pull/817) |
| |
| ## [0.4.4] - 2023-03-31 |
| |
| - Fixed [undefined `li_count` variable breaking use of readability in Cloudflare workers](https://github.com/mozilla/readability/issues/791) |
| |
| ## [0.4.3] - 2023-03-22 |
| |
| - Fixed [`aria-modal` cookie dialogs interfering with readability](https://github.com/mozilla/readability/pull/746) |
| - Fixed [lists of images not showing](https://github.com/mozilla/readability/pull/738) |
| - [Updated type information for TypeScript](https://github.com/mozilla/readability/pull/734) |
| - [Simplify `script` and `noscript` removal](https://github.com/mozilla/readability/pull/762) |
| - [Updated dependencies](https://github.com/mozilla/readability/pull/770) |
| - [Added allowedVideoRegex option to override the default](https://github.com/mozilla/readability/pull/788) |
| |
| ## [0.4.2] - 2022-02-09 |
| |
| - Fix [compatibility with DOM implementations where the `childNodes` property is not live](https://github.com/mozilla/readability/pull/694) ([x2](https://github.com/mozilla/readability/pull/677)). |
| - Lazily-loaded image references [will no longer use the `alt` attribute](https://github.com/mozilla/readability/pull/689) to find images. |
| - `parse()` [provides the root element's `lang` attribute](https://github.com/mozilla/readability/pull/721) |
| - `isProbablyReadable` [includes article tags](https://github.com/mozilla/readability/pull/724) |
| - Improvements to JSON-LD support |
| - [Continue parsing other JSON-LD elements until we find one we can support](https://github.com/mozilla/readability/pull/713) |
| - [Prefer using headline for article title](https://github.com/mozilla/readability/pull/713) |
| |
| ## [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](https://github.com/mozilla/readability/pull/634) 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](https://github.com/mozilla/readability/pull/611). |
| |
| - Readability is now more likely to [keep tables of content](https://github.com/mozilla/readability/pull/646). |
| |
| - Better support for [content in `<code>` tags](https://github.com/mozilla/readability/pull/647). |
| |
| - Readability (finally) no longer [throws away all `<h1>` tags](https://github.com/mozilla/readability/pull/650). |
| |
| ### Changed |
| |
| - JSON-LD [support for multiple authors](https://github.com/mozilla/readability/pull/618) |
| was improved. |
| |
| - Elements with roles `menu`, `menubar`, `complementary`, `navigation`, `alert`, |
| `alertdialog`, `dialog` will [all be removed](https://github.com/mozilla/readability/pull/619). |
| |
| ## [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. |
