HTML Beautifier 技术文档

本文档将向您介绍如何安装、使用以及通过API操作 HTML Beautifier，这是一个能够对HTML文件进行格式化和整理的工具，特别适用于整理Rails模板。

1. 安装指南

HTML Beautifier 是一个Ruby宝石包（gem），您可以通过以下命令安装：

$ gem install htmlbeautifier

如果您使用Bundler管理宝石依赖，可以将以下代码添加到您的 Gemfile 文件中：

gem 'htmlbeautifier'

然后在命令行运行 bundle install 以安装宝石。

2. 项目的使用说明

HTML Beautifier 的使用非常简单，以下是两种使用方式：

从命令行

• 实时更新文件：

$ htmlbeautifier file1.html.erb [file2.html.erb ...]

• 通过标准输入和输出来操作：

$ htmlbeautifier < untidy.html.erb > formatted.html.erb

在代码中使用

首先，您需要引入HtmlBeautifier库：

require 'htmlbeautifier'

然后，使用以下代码对HTML字符串进行格式化：

beautiful = HtmlBeautifier.beautify(untidy_html_string)

您还可以指定缩进方式（默认为两个空格）：

beautiful = HtmlBeautifier.beautify(untidy_html_string, indent: "\t")

3. 项目API使用文档

HTMLBeautifier模块提供了一个主要的公共方法 beautify，用于格式化HTML字符串。该方法接受以下参数：

• html_string：待格式化的HTML字符串。
• indent：（可选）指定缩进的字符，默认为两个空格。

示例：

require 'htmlbeautifier'

formatted_html = HtmlBeautifier.beautify('<div>Hello World!</div>', indent: "\t")
puts formatted_html

4. 项目安装方式

请参考上述“安装指南”部分中的步骤进行安装。简要概括，您可以直接使用Ruby gem命令或通过Bundler来安装HTML Beautifier。

通过上述说明，您应该能够顺利安装并使用HTML Beautifier来优化您的HTML代码格式。