Amber 模板引擎技术文档

本文档将详细介绍如何安装和使用 Amber，这是一个优雅的 Go 语言模板引擎，灵感来源于 HAML 和 Jade。以下是安装指南、使用说明以及项目 API 使用文档。

1. 安装指南

要使用 Amber，首先需要确保您的环境中已经安装了 Go 语言环境。以下是从源代码编译和安装 Amber 的步骤：

go get -u github.com/eknkc/amber

上述命令将会下载 Amber 的源代码，并在您的本地 GOPATH 中安装。

2. 项目使用说明

Amber 的使用非常简单，您只需要按照以下步骤进行：

• 导入 Amber 包：

import "github.com/eknkc/amber"

• 创建一个 Amber 模板，并使用数据渲染它。例如：

package main

import (
    "github.com/eknkc/amber"
    "os"
)

func main() {
    const tmplStr = `
        html
            head
                title Page Title
            body
                p Welcome #{Name}!
                p You have #{Friends} friends
    `

    data := map[string]interface{}{
        "Name":   "Ekin",
        "Friends": 17,
    }

    compiler := amber.New()
    compiler.Options = amber.DefaultOptions
    tpl, err := compiler.CompileString(tmplStr)
    if err != nil {
        panic(err)
    }

    if err := tpl.Execute(os.Stdout, data); err != nil {
        panic(err)
    }
}

上述代码将会输出一个简单的 HTML 页面，其中包括用户的名字和好友数量。

3. 项目 API 使用文档

以下是 Amber 提供的主要 API 方法：

func Compile(input string, options Options)

解析并编译给定的 Amber 模板字符串。返回相应的 Go html/template 实例。

func Compile(input string, options Options) (*template.Template, error)

func CompileFile(filename string, options Options)

解析并编译给定文件名的文件内容。返回相应的 Go html/template 实例。

func CompileFile(filename string, options Options) (*template.Template, error)

func CompileDir(dirname string, dopt DirOptions, opt Options)

解析并编译给定目录名的所有内容。返回模板名称到相应 Go html/template 实例的映射。

func CompileDir(dirname string, dopt DirOptions, opt Options) (map[string]*template.Template, error)

type Compiler

Compiler 是 Amber 模板引擎的主要接口。要使用 Amber 模板，需要创建一个 Compiler 并将 Amber 源编译为原生 Go 模板。

type Compiler struct {
    // Compiler options
    Options
}

4. 项目安装方式

除了从源代码编译安装外，您还可以使用包管理工具如 go dep 或 govendor 来添加 Amber 到您的项目中。

使用 go dep：

go get -u github.com/eknkc/amber
dep ensure -add github.com/eknkc/amber

使用 govendor：

go get -u github.com/eknkc/amber
govendor add github.com/eknkc/amber

以上步骤将会帮助您顺利地安装并开始使用 Amber 模板引擎。