NReadability 项目教程

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

NReadability 项目的目录结构如下：

NReadability/
├── Lib/
│   └── (包含项目依赖的库文件)
├── Src/
│   ├── NReadability/
│   │   ├── (包含项目的源代码文件)
│   └── NReadability.Tests/
│       └── (包含项目的单元测试代码)
├── Tools/
│   └── (包含项目使用的工具文件)
├── .gitignore
├── Build.cmd
├── LICENSE.txt
├── NReadability.build
├── NReadability.nuspec
├── PushToNuget.cmd
└── README.md

目录结构介绍

• Lib/: 包含项目依赖的库文件。
• Src/: 包含项目的源代码文件和单元测试代码。
  • NReadability/: 包含项目的核心源代码。
  • NReadability.Tests/: 包含项目的单元测试代码。
• Tools/: 包含项目使用的工具文件。
• .gitignore: Git 忽略文件配置。
• Build.cmd: 项目构建脚本。
• LICENSE.txt: 项目许可证文件。
• NReadability.build: 项目构建配置文件。
• NReadability.nuspec: NuGet 包配置文件。
• PushToNuget.cmd: 推送 NuGet 包的脚本。
• README.md: 项目说明文件。

2. 项目的启动文件介绍

NReadability 项目的主要启动文件是 NReadabilityTranscoder 类。该类位于 Src/NReadability/NReadabilityTranscoder.cs 文件中。

启动文件介绍

• NReadabilityTranscoder.cs: 这是项目的核心类，负责 HTML 页面的去杂乱处理。通过该类，可以实现对 HTML 内容的转换，使其更易于阅读。

使用示例

var transcoder = new NReadabilityTranscoder();
string content;
using (var wc = new WebClient())
{
    content = wc.DownloadString("https://github.com/marek-stoj/NReadability");
}
bool success;
string transcodedContent = transcoder.Transcode(content, out success);

3. 项目的配置文件介绍

NReadability 项目的主要配置文件是 NReadability.nuspec 文件。该文件用于配置 NuGet 包的相关信息。

配置文件介绍

• NReadability.nuspec: 该文件定义了 NuGet 包的元数据，包括包的名称、版本、描述、作者等信息。通过该文件，可以生成和发布 NuGet 包。

配置文件示例

<package>
  <metadata>
    <id>NReadability</id>
    <version>1.4.9</version>
    <title>NReadability</title>
    <authors>marek-stoj</authors>
    <owners>marek-stoj</owners>
    <description>NReadability is a tool for removing clutter from HTML pages so that they are more enjoyable to read.</description>
    <releaseNotes>Initial release.</releaseNotes>
    <copyright>Copyright 2012</copyright>
    <tags>HTML readability</tags>
  </metadata>
</package>

通过以上配置，可以生成一个包含项目代码的 NuGet 包，并发布到 NuGet 仓库中。