readability

README

readability

readability is a Go package that cleans a HTML page from clutter like buttons, ads and background images, and changes the page's text size, contrast and layout for better readability.

Documentation

Index

• type Article
  • func FromReader(reader io.Reader, url *nurl.URL) (Article, error)
  • func FromURL(url *nurl.URL, timeout time.Duration) (Article, error)
• type Metadata

Types

type Article

type Article struct {
	URL        string
	Meta       Metadata
	Content    string
	RawContent string
}

Article is the content of an URL

func FromReader

func FromReader(reader io.Reader, url *nurl.URL) (Article, error)

FromReader get readable content from the specified io.Reader

func FromURL

func FromURL(url *nurl.URL, timeout time.Duration) (Article, error)

FromURL get readable content from the specified URL

type Metadata

type Metadata struct {
	Title         string
	Image         string
	Excerpt       string
	Author        string
	MinReadTime   int
	MaxReadTime   int
	AMPURL        string
	CanonicalURL  string
	PublishedDate struct {
		Raw    string
		Parsed time.Time
	}
}

Metadata is metadata of an article