# readability **Repository Path**: xdlove/readability ## Basic Information - **Project Name**: readability - **Description**: A standalone version of the readability lib - **Primary Language**: JavaScript - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2020-01-16 - **Last Updated**: 2025-01-18 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # Readability.js A standalone version of the readability library used for Firefox Reader View. ## Usage on the web. To parse a document, you must create a new `Readability` object from a DOM document object, and then call `parse()`. Here's an example: ```javascript var article = new Readability(document).parse(); ``` This `article` object will contain the following properties: * `title`: article title * `content`: HTML string of processed article content * `length`: length of an article, in characters * `excerpt`: article description, or short excerpt from the content * `byline`: author metadata * `dir`: content direction If you're using Readability on the web, you will likely be able to use a `document` reference from elsewhere (e.g. fetched via XMLHttpRequest, in a same-origin `