Markaby 技术文档

1. 安装指南

使用 Bundler 安装

在 Gemfile 中添加以下内容：

gem 'markaby'

然后运行以下命令安装：

bundle install

使用 Markaby 与 Rails 4/5+

安装 gem 后，在 config/initializers/markaby.rb 文件中添加以下内容：

require 'markaby/rails'

Markaby::Rails::TemplateHandler.register!({
  tagset: Markaby::HTML5,
  indent: 2,
})

将模板文件命名为 html.mab 扩展名，并配置文本编辑器将 .mab 文件视为 Ruby 文件。

使用 Markaby 与 Sinatra

在 Sinatra 中使用 Markaby 时，可以这样配置：

get '/foo' do
  mab :my_template # my_template.mab 在 Sinatra 视图路径中
end

使用 Markaby 与其他框架

Markaby 可以通过 Tilt 模块与支持 Tilt 的任何 Web 框架一起使用。

2. 项目的使用说明

基本用法

Markaby 是一个用于在纯 Ruby 中编写 HTML 页面的工具。它提供了一种替代 ERb 的方式，允许你使用 Ruby 代码生成 HTML。

示例

以下是一个简单的 Markaby 示例：

require 'markaby'

mab = Markaby::Builder.new
mab.html do
  head { title "Boats.com" }
  body do
    h1 "Boats.com has great deals"
    ul do
      li "$49 for a canoe"
      li "$39 for a raft"
      li "$29 for a huge boot that floats and can fit 5 people"
    end
  end
end
puts mab.to_s

使用 Markaby 在 Rails 中生成 HTML

在 Rails 中，你可以使用 Markaby 生成 HTML 模板。将模板文件命名为 html.mab，并在控制器中调用 render 方法。

使用 Markaby 在 Sinatra 中生成 HTML

在 Sinatra 中，你可以直接在路由中使用 mab 方法来生成 HTML。

3. 项目 API 使用文档

Markaby::Builder

Markaby::Builder 是 Markaby 的核心类，用于生成 HTML。你可以通过以下方式创建一个 Builder 实例：

mab = Markaby::Builder.new

方法

• html: 生成 HTML 文档的根元素。
• head: 生成 HTML 文档的头部。
• body: 生成 HTML 文档的主体。
• tag!: 强制生成一个标签，适用于自定义标签。

示例

mab = Markaby::Builder.new
mab.html do
  head { title "Boats.com" }
  body do
    h1 "Boats.com has great deals"
    ul do
      li "$49 for a canoe"
      li "$39 for a raft"
      li "$29 for a huge boot that floats and can fit 5 people"
    end
  end
end
puts mab.to_s

4. 项目安装方式

使用 Bundler 安装

在 Gemfile 中添加以下内容：

gem 'markaby'

然后运行以下命令安装：

bundle install

手动安装

你也可以通过以下命令手动安装 Markaby：

gem install markaby

使用 Markaby 与 Rails

在 Rails 项目中，安装 Markaby 后，需要在 config/initializers/markaby.rb 文件中进行配置：

require 'markaby/rails'

Markaby::Rails::TemplateHandler.register!({
  tagset: Markaby::HTML5,
  indent: 2,
})

使用 Markaby 与 Sinatra

在 Sinatra 项目中，可以直接在路由中使用 mab 方法来生成 HTML。

通过以上步骤，你可以轻松地在不同框架中使用 Markaby 生成 HTML 页面。