n8n-nodes-html-readability

This is an n8n community node. It lets you use Mozilla's Readability in your n8n workflows.

Mozilla's Readability is a standalone version of the algorithm used by Firefox Reader View to extract the main content from web pages, removing clutter and providing clean, readable text.

n8n is a fair-code licensed workflow automation platform.

Installation
Operations
Compatibility
Usage
Development
Releasing
Resources

Installation

Follow the installation guide in the n8n community nodes documentation.

Operations

HTML

Extract Content

Extracts the main content from HTML, removing navigation, ads, and other distracting elements.

Options:

| Parameter | Type | Description | |:--------:|:----:|:------------| | JSON Property | String | The property containing the HTML content to parse. Supports both dot notation (e.g., 'solution.response') and expressions | | Continue on Error | Boolean | Whether to continue execution when the node encounters an error | | Return Full Response | Boolean | Whether to return the full Readability response including metadata |

Output:

Default output includes:

{
  "content": "<div>...extracted HTML content...</div>",
  "title": "Article Title",
  "excerpt": "Brief excerpt of the content"
}

With "Return Full Response" enabled, additional fields are included:

{
  "content": "<div>...extracted HTML content...</div>",
  "title": "Article Title",
  "excerpt": "Brief excerpt of the content",
  "length": 12345,
  "byline": "Author Name",
  "dir": "ltr",
  "siteName": "Website Name",
  "textContent": "Plain text version of the content"
}

Compatibility

• Requires n8n version 1.0.0 or later
• Uses Mozilla's Readability v0.6.0
• Node.js v18.10 or later

Usage

1. Add the Readability node to your workflow
2. Connect it to a node that provides HTML content (e.g., HTTP Request)
3. Specify the JSON property containing the HTML (e.g., 'data' or 'response.body')
4. Optionally enable "Return Full Response" for additional metadata
5. Run the workflow to extract clean, readable content

Example Usage

This example shows how to extract readable content from a webpage:

1. HTTP Request node: Fetch a webpage
2. Readability node:
   • Set "JSON Property" to "data"
   • Enable "Return Full Response" if you need metadata
3. The node will output clean HTML content and metadata

Development

Prerequisites

• Node.js v18.10+
• pnpm v9.1+

Setup

pnpm install

Build

pnpm build

Local Testing with n8n

pnpm dev

This builds the node, links it into your local n8n installation, and starts watching for changes.

Linting & Formatting

pnpm lint        # check for issues
pnpm lintfix     # auto-fix issues
pnpm format      # format with prettier

Releasing

Releases are automated via GitHub Actions. When a version tag is pushed, CI builds the package and publishes it to npm.

Release a new version

pnpm version patch   # bumps version, commits, and creates a git tag
git push --follow-tags

Replace patch with minor or major as appropriate.

CI Setup (one-time)

Publishing uses npm OIDC Trusted Publishing — no long-lived tokens to rotate.

1. Go to your package on npmjs.com > Settings > Trusted Publishers
2. Add a GitHub Actions publisher with repository TechupBusiness/n8n-nodes-html-readability and workflow publish.yml

Resources

• n8n community nodes documentation
• Mozilla Readability Documentation
• Firefox Reader View Blog Post

License

MIT