Ruby Readability 技术文档

本文档将详细介绍如何安装、使用Ruby Readability项目，以及如何通过项目API进行操作。

1. 安装指南

Ruby Readability 是一个用于提取网页主要可读内容的工具，它是 arc90 的 readability 项目的 Ruby 语言版本。

通过命令行安装

(sudo) gem install ruby-readability

使用 Bundler 安装

gem "ruby-readability", :require => 'readability'

2. 项目使用说明

Ruby Readability 可以通过以下方式使用：

require 'rubygems'
require 'readability'
require 'open-uri'

source = open('http://example.com/').read
document = Readability::Document.new(source)
puts document.content

配置选项

您可以通过以下选项配置 Readability::Document.new：

• :tags: 指定要清理的基本标签列表，默认为 %w[div p]。
• :remove_empty_nodes: 删除没有文本内容的 <p> 标签，同时也删除只包含图片的 <p> 标签。
• :attributes: 指定允许的属性列表。
• :debug: 提供调试输出，默认为 false。
• :encoding: 如果页面是已知的编码，可以指定它；如果未指定，编码将被猜测（仅限 Ruby 1.9.x）。如果您希望禁用猜测，请提供 :do_not_guess_encoding => true。
• :html_headers: 在 Ruby 1.9.x 中，这些将被传递给 guess_html_encoding gem 以帮助猜测 HTML 编码。
• :ignore_image_format: 用于 .images。例如：[:ignore_image_format => ["gif", "png"]]。
• :min_image_height: 设置 #images 的最小图像高度。
• :min_image_width: 设置 #images 的最小图像宽度。
• :blacklist 和 :whitelist 允许您显式地限制或移除 CSS 选择器。

3. 项目API使用文档

以下是 Ruby Readability 的一些主要 API 方法：

提取内容

document = Readability::Document.new(source, options)
puts document.content

提取图片

document = Readability::Document.new(source, options)
puts document.images

4. 项目安装方式

请参考上述“安装指南”部分，了解如何通过命令行或 Bundler 安装 Ruby Readability。

通过本文档，用户应能够顺利安装并使用 Ruby Readability，从而提取网页的主要内容。如果在使用过程中遇到任何问题，建议查阅相关文档或向社区寻求帮助。