Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/AndrejGajdos/link-preview-generator

Get preview data (a title, description, image, domain name) from a url. Library uses puppeteer headless browser to scrape the web site.
https://github.com/AndrejGajdos/link-preview-generator

javascript link-preview node node-js open-graph preview url

Last synced: about 1 month ago
JSON representation

Get preview data (a title, description, image, domain name) from a url. Library uses puppeteer headless browser to scrape the web site.

Host: GitHub
URL: https://github.com/AndrejGajdos/link-preview-generator
Owner: AndrejGajdos
License: mit
Created: 2019-11-12T12:54:33.000Z (about 5 years ago)
Default Branch: master
Last Pushed: 2024-05-03T16:21:18.000Z (7 months ago)
Last Synced: 2024-10-20T08:48:34.080Z (about 2 months ago)
Topics: javascript, link-preview, node, node-js, open-graph, preview, url
Language: JavaScript
Homepage:
Size: 121 KB
Stars: 262
Watchers: 9
Forks: 65
Open Issues: 9
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

project-awesome - AndrejGajdos/link-preview-generator - Get preview data (a title, description, image, domain name) from a url. Library uses puppeteer headless browser to scrape the web site. (JavaScript)

README

# link-preview-generator

![NPM Downloads](https://img.shields.io/npm/dw/link-preview-generator)
![NPM License](https://img.shields.io/npm/l/link-preview-generator)
[![Twitter](https://img.shields.io/twitter/follow/Andrej_Gajdos.svg?style=social&label=@Andrej_Gajdos)](https://twitter.com/Andrej_Gajdos)

> Get preview data (a title, description, image, domain name) from a url. Library uses puppeteer headless browser to scrape the web site.

[BLOG POST](https://andrejgajdos.com/how-to-create-a-link-preview/) and [DEMO](https://link-preview-generator.herokuapp.com/)

## Install

```
$ npm install link-preview-generator
```

## Usage

```js
const linkPreviewGenerator = require("link-preview-generator");

const previewData = await linkPreviewGenerator(
"https://www.youtube.com/watch?v=8mqqY2Ji7_g"
);
console.log(previewData);
/*
{
title: 'Kiteboarding: Stylish Backroll in 4 Sessions - Ride with Blake: Vlog 20',
description: 'The backroll is a staple in your kiteboarding trick ' +
'bag. With a few small adjustments, you can really ' +
'improve your style and make this basic your own. ' +
'Sessio...',
domain: 'youtube.com',
img: 'https://i.ytimg.com/vi/8mqqY2Ji7_g/hqdefault.jpg',
favicon: 'https://www.youtube.com/s/desktop/d3411c39/img/favicon.ico'
}
*/
```

## API

### linkPreviewGenerator(url, puppeteerArgs?, puppeteerAgent?)

Accepts a `url`, which is scraped and optional parameters `puppeteerArgs` -- browser options and `puppeteerAgent` -- browser user agent.

Returns an object with preview data of `url`.

#### url

Type: `string`

Scraped url.

#### puppeteerArgs

Type: `array`

Options to set on the Chrome browser.

#### puppeteerAgent

Type: `string`

Specific user agent to use.

## Troubleshooting
If you need to deploy this library (Puppeteer) on Heroku, follow [these steps](https://stackoverflow.com/a/55090914/968379).

If you want to run this library from within a Docker container:
1. pass the following puppeteer arguments as second argument
```json
// Required for Docker version of Puppeteer
'--no-sandbox',
'--disable-setuid-sandbox',
// This will write shared memory files into /tmp instead of /dev/shm,
// because Docker’s default for /dev/shm is 64MB
'--disable-dev-shm-usage'
```
2. make sure your Docker image has all needed dependencies for headless chrome or just go straight away with [buildkite/puppeteer](https://hub.docker.com/r/buildkite/puppeteer/dockerfile)
3. done

## License