You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
mercury-parser/README.md

8.9 KiB

Mercury Parser - Extracting content from chaos

CircleCI Build status Apache License

The Mercury Parser extracts the bits that humans care about from any URL you give it. That includes article content, titles, authors, published dates, excerpts, lead images, and more.

The Mercury Parser module powers the Mercury Parser API, a free API from Postlight that puts all of this information one API request away..

How? Like this.

Installation

yarn add @postlight/mercury-parser

Usage

import Mercury from '@postlight/mercury-parser';

Mercury.parse(url).then(result => console.log(result););

The result looks like this:

{
  "title": "Thunder (mascot)",
  "content": "<div><div><p>This is the content of the page!</div></div>",
  "author": "Wikipedia Contributors",
  "date_published": "2016-09-16T20:56:00.000Z",
  "lead_image_url": null,
  "dek": null,
  "next_page_url": null,
  "url": "https://en.wikipedia.org/wiki/Thunder_(mascot)",
  "domain": "en.wikipedia.org",
  "excerpt": "Thunder Thunder is the stage name for the horse who is the official live animal mascot for the Denver Broncos",
  "word_count": 4677,
  "direction": "ltr",
  "total_pages": 1,
  "rendered_pages": 1
}

If Mercury is unable to find a field, that field will return null.

License

Licensed under either of the below, at your preference:

Contributing

Unless it is explicitly stated otherwise, any contribution intentionally submitted for inclusion in the work, as defined in the Apache-2.0 license, shall be dual licensed as above without any additional terms or conditions.

Contributors

All Contributors

Adam Pash
Adam Pash

📝 💻 📖 💡
Toy Vano
Toy Vano

💻
Drew Bell
Drew Bell

💻
Jeremy Mack
Jeremy Mack

💻
George Haddad
George Haddad

💻 📖
Toufic Mouallem
Toufic Mouallem

💻 📖
Wajeeh Zantout
Wajeeh Zantout

💻 📖
Marc Esso
Marc Esso

💻 📖
Jad Termsani
Jad Termsani

💻 📖
Ralph Jbeily
Ralph Jbeily

💻 📖
Alexi Akl
Alexi Akl

💻