A standalone version of the readability library used for Firefox Reader View. Any changes to Readability.js itself should be reviewed by an appropriate Firefox/toolkit peer, such as @gijsk, since these changes will be automatically merged to mozilla-central.
For outstanding issues, see the issue list in this repo, as well as this bug list.
To test local changes to Readability.js, you can use the automated tests. There's a node script to help you create new ones.
Please make sure to run eslint against any proposed changes when creating a pull request.
To parse a document, you must create a new
Readability object from a document object, and then call
parse(). Here's an example:
var article = new Readability(document).parse();
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
<iframe> you have access to, etc.).
Otherwise, you would need to construct such an object using a DOM parser such as jsdom. While this repository contains a parser of its own (
JSDOMParser), that is restricted to reading XML-compatible markup and therefore we do not recommend it for general use.
If you‘re using
jsdom to create a DOM object, you should ensure that the page doesn’t run (page) scripts (avoid fetching remote resources etc.) as well as passing it the page's URI as the
url property of the
options object you pass the
parse() works by modifying the DOM. This removes some elements in the web page. You could avoid this by passing the clone of the
document object while creating a
var documentClone = document.cloneNode(true); var article = new Readability(documentClone).parse();
Please run eslint as a first check that your changes adhere to our style guidelines.
To run the test suite:
$ mocha test/test-*.js
To run a specific test page by its name:
$ mocha test/test-*.js -g 001
To run the test suite in TDD mode:
$ mocha test/test-*.js -w
$ mocha test/test-*.js -w -g 001
Benchmarks for all test pages:
$ npm run perf
$ npm run perf-reference
Copyright (c) 2010 Arc90 Inc Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.