Readability-js 项目教程

2024-08-31 14:05:21作者：何将鹤

1. 项目的目录结构及介绍

readability-js/
├── LICENSE
├── README.md
├── package.json
├── src/
│   ├── Readability.js
│   ├── utils.js
│   └── ...
├── test/
│   ├── Readability-test.js
│   └── ...
└── ...

LICENSE: 项目许可证文件。
README.md: 项目说明文档。
package.json: 项目依赖和脚本配置文件。
src/: 源代码目录，包含核心功能文件如 Readability.js 和辅助工具文件如 utils.js。
test/: 测试代码目录，包含各种测试文件如 Readability-test.js。

2. 项目的启动文件介绍

项目的启动文件通常是 src/Readability.js，这是核心功能文件，负责解析和处理网页内容。

// src/Readability.js
const { Readability } = require('@mozilla/readability');
const JSDOM = require('jsdom').JSDOM;

// 示例代码
const doc = new JSDOM("<body>Here's a bunch of text</body>", { url: "https://example.com/the-page-i-got-the-source-from" });
let reader = new Readability(doc.window.document);
let article = reader.parse();

3. 项目的配置文件介绍

项目的配置文件主要是 package.json，它包含了项目的依赖、脚本和其他元数据。

{
  "name": "readability-js",
  "version": "1.0.0",
  "description": "A standalone version of the readability library used for Firefox Reader View",
  "main": "src/Readability.js",
  "scripts": {
    "test": "mocha test/"
  },
  "dependencies": {
    "@mozilla/readability": "^0.4.1",
    "jsdom": "^16.4.0"
  },
  "devDependencies": {
    "mocha": "^8.2.1"
  }
}

name: 项目名称。
version: 项目版本。
description: 项目描述。
main: 项目入口文件。
scripts: 项目脚本，如测试脚本 test。
dependencies: 项目运行依赖。
devDependencies: 项目开发依赖。