npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@reader-app/one

v1.0.1

Published

A library to generate simple HTML (Reader View) from Complex sites

Downloads

1

Readme

@reader-app/one

one is an utility to get simple HTML from otherwise complex HTML.

Installation

npm i @reader-app/one

Example

const one = require("@reader-app/one");

one(
	"<div>some complex html (even with ads)</div>",
	"http://site.com/where-you-got-this-from"
).then((article) => console.log(article));

Note that one exports a Promise. Also, one never fetch anything, you must fetch data on your own.

Usage

one accepts two parameters which are all required.

  • content: Complex HTML to be transformed into readable HTML
  • url: URL to resolve relative URLs,

one returns an object with the following properties:

  • url: The provided URL.
  • title: The resolved title of the document (Got from html, og, twitter or jsonld tags).
  • byline: The author of the document as specified in the HTML.
  • dir: Direction of the text (rtl or ltr or null).
  • content: Simplified HTML.
  • textContent: Simplified text (no HTML tags).
  • length: The number of characters the document has.
  • excerpt: Description of the document (Got from html, og, twitter or jsonld tags) or excerpt from first paragraph.
  • siteName: The name of the site.
  • readable: Whether or not the app thinks the given HTML is meant to be simplified.
  • author: The name of the first or primary author.
  • date: The date the article was created (Note that date can be in a variety of formats. You can use new Date(article.date) to handle most of them).
  • image: The url of the hero image of the article.

Example data

Note that content and textContent are omitted for brevity.

{
	"title": "How To Work with Date and Time in JavaScript using Date Objects | DigitalOcean",
	"byline": null,
	"dir": null,
	"content": "omitted",
	"textContent": "omitted as well",
	"siteName": "DigitalOcean",
	"readable": true,
	"author": "Tania Rascia",
	"date": "2017-10-19T20:15:53Z",
	"image": "https://community-cdn-digitalocean-com.global.ssl.fastly.net/variants/eqK1m9xGjBo7WaC62F3duT5E/035575f2985fe451d86e717d73691e533a1a00545d7230900ed786341dc3c882",
	"url": "https://www.digitalocean.com/community/tutorials/understanding-date-and-time-in-javascript"
}