Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/ci-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:

strategy:
matrix:
node_version: [18.x, 20.x, 22.x, 23.x]
node_version: [20.x, 22.x, 23.x]

steps:
- uses: actions/checkout@v4
Expand Down
38 changes: 9 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,47 +10,27 @@ Extract main article, main image and meta data from URL.

## Demo

- [Give it a try!](https://extractor-demos.pages.dev/article-extractor)
- [Example FaaS](https://extractus.deno.dev/extract?apikey=rn0wbHos2e73W6ghQf705bdF&type=article&url=https://github.blog/2022-11-17-octoverse-2022-10-years-of-tracking-open-source/)
- [Give it a try!](https://extractus-demo.vercel.app/article)


## Install & Usage

### Node.js
## Install

```bash
# npm, pnpm, yarn
npm i @extractus/article-extractor

# pnpm
pnpm i @extractus/article-extractor

# yarn
yarn add @extractus/article-extractor
```

```ts
// es6 module
import { extract } from '@extractus/article-extractor'
# bun
bun add @extractus/article-extractor
```

### Deno
## Usage

```ts
import { extract } from 'https://esm.sh/@extractus/article-extractor'
import { extract } from '@extractus/article-extractor'

// deno > 1.28
import { extract } from 'npm:@extractus/article-extractor'
const data = await extract(ARTICLE_URL)
console.log(data)
```

### Browser

```ts
import { extract } from 'https://esm.sh/@extractus/article-extractor'
```

Please check [the examples](examples) for reference.


## APIs

- [extract()](#extract)
Expand Down
17 changes: 9 additions & 8 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"version": "8.0.17",
"version": "8.0.18",
"name": "@extractus/article-extractor",
"description": "To extract main article from given URL",
"homepage": "https://github.com/extractus/article-extractor",
Expand Down Expand Up @@ -30,18 +30,19 @@
"reset": "node reset"
},
"dependencies": {
"@mozilla/readability": "^0.5.0",
"@mozilla/readability": "^0.6.0",
"bellajs": "^11.2.0",
"cross-fetch": "^4.1.0",
"linkedom": "^0.18.9",
"sanitize-html": "2.14.0"
"linkedom": "^0.18.10",
"sanitize-html": "2.16.0"
},
"devDependencies": {
"@types/sanitize-html": "^2.13.0",
"eslint": "^9.20.0",
"globals": "^15.14.0",
"@eslint/js": "^9.26.0",
"@types/sanitize-html": "^2.15.0",
"eslint": "^9.26.0",
"globals": "^16.0.0",
"https-proxy-agent": "^7.0.6",
"nock": "^14.0.1"
"nock": "^14.0.4"
},
"keywords": [
"article",
Expand Down
Loading