Skip to content
πŸ“œ Extract meaningful content from the chaos of a web page
JavaScript Shell
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci chore: prevent adding phantomjs-prebuilt as a dependency in CI. (#412) Jun 26, 2019
.github docs: PR and Issue templates (#211) Jan 24, 2019
assets docs: add usage gif (#308) Mar 5, 2019
dist release: 2.2.0 (#496) Sep 10, 2019
fixtures feat: ability to add custom extractors via api (#484) Sep 4, 2019
scripts chore: remove unneeded import (#357) Apr 3, 2019
src feat: ability to add custom extractors via api (#484) Sep 4, 2019
.agignore chore: renamed iris to mercury Sep 16, 2016
.babelrc chore: update node rollup config (#229) Jan 30, 2019
.eslintignore Feat: browser support (#19) Nov 21, 2016
.eslintrc deps: upgrade (#218) Jan 23, 2019
.gitattributes fix: i put a bad comment in .gitattributes (#125) Jan 27, 2017
.gitignore dx: include test results in comment (#230) Jan 30, 2019
.nvmrc chore: update node and some deps (#209) Jan 17, 2019
.prettierignore dx: add .prettierignore (#257) Feb 8, 2019
.prettierrc a more explicit .prettierrc Feb 1, 2019
.remarkrc feat: add remarklint for md docs (#213) Jan 24, 2019
CHANGELOG.md release: 2.2.0 (#496) Sep 10, 2019
CODE_OF_CONDUCT.md chore: small CoC typofix (#358) Apr 5, 2019
CONTRIBUTING.md docs: cleanup and update docs (#238) Feb 1, 2019
LICENSE-APACHE docs: add license files (#217) Jan 24, 2019
LICENSE-MIT docs: add license files (#217) Jan 24, 2019
README.md feat: ability to add custom extractors via api (#484) Sep 4, 2019
RELEASE.md docs: document release process (#186) Dec 20, 2018
cli.js feat: ability to add custom extractors via api (#484) Sep 4, 2019
karma.conf.js deps: upgrade (#218) Jan 23, 2019
package.json chore(package): update ora to version 4.0.0 (#500) Sep 25, 2019
preview feat: add content format output options (#256) Feb 8, 2019
rollup.config.js deps: upgrade (#218) Jan 23, 2019
rollup.config.web.js deps: upgrade (#218) Jan 23, 2019
score-move chore: refactored and linted Sep 13, 2016
yarn.lock deps: Update wuzzy to fix vulnerability (#462) Aug 21, 2019

README.md

Mercury Parser

Mercury Parser - Extracting content from chaos

CircleCI Greenkeeper badge Apache License MITC License Gitter chat

Postlight's 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.

Mercury Parser powers the Mercury AMP Converter and Mercury Reader, a Chrome extension that removes ads and distractions, leaving only text and images for a beautiful reading view on any site.

Mercury Parser allows you to easily create custom parsers using simple JavaScript and CSS selectors. This allows you to proactively manage parsing and migration edge cases. There are many examples available along with documentation.

How? Like this.

Installation

# If you're using yarn
yarn add @postlight/mercury-parser

# If you're using npm
npm install @postlight/mercury-parser

Usage

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

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

// NOTE: When used in the browser, you can omit the URL argument
// and simply run `Mercury.parse()` to parse the current page.

The result looks like this:

{
  "title": "Thunder (mascot)",
  "content": "... <p><b>Thunder</b> is the <a href=\"https://en.wikipedia.org/wiki/Stage_name\">stage name</a> for the...",
  "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.

parse() Options

Content Formats

By default, Mercury Parser returns the content field as HTML. However, you can override this behavior by passing in options to the parse function, specifying whether or not to scrape all pages of an article, and what type of output to return (valid values are 'html', 'markdown', and 'text'). For example:

Mercury.parse(url, { contentType: 'markdown' }).then(result =>
  console.log(result)
);

This returns the the page's content as GitHub-flavored Markdown:

"content": "...**Thunder** is the [stage name](https://en.wikipedia.org/wiki/Stage_name) for the..."
Custom Request Headers

You can include custom headers in requests by passing name-value pairs to the parse function as follows:

Mercury.parse(url, {
  headers: {
    Cookie: 'name=value; name2=value2; name3=value3',
    'User-Agent':
      'Mozilla/5.0 (iPhone; CPU iPhone OS 10_3_1 like Mac OS X) AppleWebKit/603.1.30 (KHTML, like Gecko) Version/10.0 Mobile/14E304 Safari/602.1',
  },
}).then(result => console.log(result));
Pre-fetched HTML

You can use Mercury Parser to parse custom or pre-fetched HTML by passing an HTML string to the parse function as follows:

Mercury.parse(url, {
  html:
    '<html><body><article><h1>Thunder (mascot)</h1><p>Thunder is the stage name for the horse who is the official live animal mascot for the Denver Broncos</p></article></body></html>',
}).then(result => console.log(result));

Note that the URL argument is still supplied, in order to identify the web site and use its custom parser, if it has any, though it will not be used for fetching content.

The command-line parser

Mercury Parser also ships with a CLI, meaning you can use the Mercury Parser from your command line like so:

Mercury Parser CLI Basic Usage

# Install Mercury globally
yarn global add @postlight/mercury-parser
#   or
npm -g install @postlight/mercury-parser

# Then
mercury-parser https://postlight.com/trackchanges/mercury-goes-open-source

# Pass optional --format argument to set content type (html|markdown|text)
mercury-parser https://postlight.com/trackchanges/mercury-goes-open-source --format=markdown

# Pass optional --header.name=value arguments to include custom headers in the request
mercury-parser https://postlight.com/trackchanges/mercury-goes-open-source --header.Cookie="name=value; name2=value2; name3=value3" --header.User-Agent="Mozilla/5.0 (iPhone; CPU iPhone OS 10_3_1 like Mac OS X) AppleWebKit/603.1.30 (KHTML, like Gecko) Version/10.0 Mobile/14E304 Safari/602.1"

# Pass optional --extend argument to add a custom type to the response
mercury-parser https://postlight.com/trackchanges/mercury-goes-open-source --extend credit="p:last-child em"

# Pass optional --extend-list argument to add a custom type with multiple matches
mercury-parser https://postlight.com/trackchanges/mercury-goes-open-source --extend-list categories=".meta__tags-list a"

# Get the value of attributes by adding a pipe to --extend or --extend-list
mercury-parser https://postlight.com/trackchanges/mercury-goes-open-source --extend-list links=".body a|href"

# Pass optional --add-extractor argument to add a custom extractor at runtime.
mercury-parser https://postlight.com/trackchanges/mercury-goes-open-source --add-extractor ./src/extractors/fixtures/postlight.com/index.js

License

Licensed under either of the below, at your preference:

Contributing

For details on how to contribute to Mercury, including how to write a custom content extractor for any site, see CONTRIBUTING.md

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.


πŸ”¬ A Labs project from your friends at Postlight. Happy coding!

You can’t perform that action at this time.