HTML2HAML 项目技术文档

1. 安装指南

在开始使用 HTML2HAML 项目之前，您需要确保您的开发环境满足以下要求：

• Ruby 1.9.3 或更高版本
• Bundler

安装步骤如下：

1. 克隆项目仓库到本地：

   git clone git://github.com/twilson63/html2haml.git
   

2. 使用 Bundler 安装项目依赖：

   bundle install
   

3. 运行测试来验证安装：

   rake
   

4. 启动应用：

   rackup
   

5. 在浏览器中打开 http://localhost:9292 查看应用。

2. 项目的使用说明

HTML2HAML 项目是一个基于 Sinatra 的 Web 应用程序，它能够将 HTML 转换为 HAML。以下是如何使用该项目的说明：

• HTML 文本转换：在 HTML 文本区域中粘贴您的 HTML 代码，然后点击“转换”按钮。HTML2HAML 将会在下方的文本区域中显示转换后的 HAML 代码。

• URL 转换：输入一个网页的 URL 并点击“提交”按钮，HTML2HAML 将会下载该页面并将其转换为 HAML，然后在下方的文本区域中显示。

• 使用 JSON 进行转换：您可以通过 POST 请求发送包含 HTML 的 JSON 数据，如下所示：

  {
    "page": {
      "html": "<h1>Hello World</h1>"
    }
  }
  

  并接收到包含 HAML 的响应：

  {
    "page": {
      "html": "<h1>Hello World</h1>",
      "haml": "%h1 Hello World"
    }
  }
  

3. 项目API使用文档

HTML2HAML 提供了一个简单的 API，用于将 HTML 转换为 HAML。以下是 API 使用文档：

• Endpoint: /
• Method: POST
• Body: JSON 对象，包含要转换的 HTML 代码。
• Response: JSON 对象，包含原始 HTML 代码和转换后的 HAML 代码。

请求示例：

POST / HTTP/1.1
Content-Type: application/json

{
  "page": {
    "html": "<h1>Hello World</h1>"
  }
}

响应示例：

{
  "page": {
    "html": "<h1>Hello World</h1>",
    "haml": "%h1 Hello World"
  }
}

4. 项目安装方式

HTML2HAML 项目的安装方式已在“安装指南”部分详细说明。简要步骤如下：

• 克隆项目仓库。
• 使用 Bundler 安装依赖。
• 运行测试。
• 启动应用。

请遵循以上步骤，以成功安装并运行 HTML2HAML 项目。