HTML-Pipeline 使用手册

HTML-Pipeline 使用手册

html-pipeline项目地址:https://gitcode.com/gh_mirrors/htm/html-pipeline

1. 项目目录结构及介绍

HTML-Pipeline 是一个用于处理 HTML 的 Ruby 库，它通过一系列可链式的过滤器来转换用户生成的内容为安全且格式化的 HTML 标记。以下是其典型的项目目录结构以及关键部分的简要说明：

• lib/html/pipeline
  这个目录包含了核心的过滤器实现（如 TextFilter, ConvertFilter, 和 SanitizationFilter）和一些默认的过滤器类，如 Markdown 转换和图片过滤。

• spec
  单元测试和集成测试所在目录，确保每个过滤器按预期工作，并且整个管道的功能完整。

• Gemfile
  项目依赖定义文件，用于在开发环境中管理必需的宝石(gems)。

• Rakefile
  用于执行常见的项目任务，比如测试、文档生成等的标准 Ruby 构建文件。

• README.md
  项目的主要文档，包含了安装指南、基本使用方法和一些高级设置。

• LICENSE.txt
  许可证文件，声明了软件的使用条款，HTML-Pipeline 使用 MIT 许可证。

2. 项目的启动文件介绍

在 HTML-Pipeline 中，并没有传统的“启动文件”概念，因为其作为库嵌入到其他应用中。然而，当你在自己的项目中想要开始使用 HTML-Pipeline 时，通常会在你的应用程序代码里初始化一个 Pipeline 实例。以下是如何在 Ruby 应用中“启动”或实例化 HTML-Pipeline 的简例：

require 'html/pipeline'

pipeline = HTML::Pipeline.new([
  HTML::Pipeline::TextFilter.new,
  HTML::Pipeline::MarkdownFilter.new,
], {
  sanitize: true,
})

result = pipeline.call("你的用户输入文本")
puts result[:output].to_s

这段代码示例演示了如何创建一个简单的 Pipeline，它先对文本进行处理，然后转换Markdown，最后输出已处理的HTML内容。

3. 项目的配置文件介绍

HTML-Pipeline本身不直接提供一个预设的配置文件模板。配置是通过在实例化 Pipeline 或特定过滤器时传入参数完成的。例如，对于过滤器的配置主要涉及以下几个方面：

• SanitizationConfig
  如果需要自定义允许的HTML标签和属性，可以在创建 Pipeline 实例时通过 sanitization_config 参数进行配置。这可以是自定义的配置哈希或者直接使用 HTML::Pipeline::SanitizationFilter::DEFAULT_CONFIG 并进行修改。

• Text Filters 配置
  文本过滤器的顺序和使用可以通过调整传递给 Pipeline 构造函数的第一个参数列表来进行定制。

• Node Filters配置
  如果需要操作或筛选特定的DOM节点，可通过 node_filters 参数指定对应的节点过滤器类。

因此，配置通常是动态地在代码中进行，而不是通过外部配置文件加载。如果你的应用有复杂的配置需求，可能会在应用级别维护配置变量或YAML文件，然后在实例化 Pipeline 时引用这些配置值。但这种情况下，配置管理属于应用层面而非 HTML-Pipeline 直接提供的功能。

html-pipeline项目地址:https://gitcode.com/gh_mirrors/htm/html-pipeline