Home

Welcome to the documentation for @canvasflow/feed — the Canvasflow utility for processing RSS/Atom feeds and transforming their HTML content into structured Canvasflow components.

This wiki is the reference for how feeds are parsed and how HTML is mapped to Canvasflow components. For installation, usage examples, and the available scripts, see the project README.

Contents

Page	Description
HTML	How HTML elements are matched to Canvasflow components — text, images, galleries, video, audio, buttons, social embeds, tables, and container components.
Mappings	The Params/Mapping configuration model: filters, match modes, excludes, and every component mapping (container, columns, gallery, live container, …).
RSS	The supported RSS structure and namespaces (Atom, Dublin Core, Syndication, Content, Media RSS, and the Canvasflow cf: extensions).

Overview

@canvasflow/feed exposes two public surfaces:

• RSSFeed — parses and validates a feed, then builds a typed RSS object. Each item's content:encoded HTML is automatically converted into a components array. See RSS.
• HTMLMapper — converts an HTML string directly into a list of Canvasflow components. See HTML for the element-to-component rules and Mappings for configuring custom detection.

Where to start

• New to the library? Begin with HTML to understand how content is interpreted.
• Need to customize how elements are detected? Read Mappings.
• Working with feed structure and metadata? See RSS.