CoffeeCup 技术文档

1. 安装指南

在开始使用 CoffeeCup 之前，您需要确保已经安装了 Node.js 和 npm（Node.js 的包管理器）。以下是安装 CoffeeCup 的步骤：

npm install coffeecup

如果您希望全局安装 CoffeeCup 以便在命令行中使用，可以使用以下命令：

npm install coffeecup -g

此外，您还可以通过克隆 GitHub 仓库并构建项目来获取最新版本的 CoffeeCup：

git clone [e-mail]:gradus/coffeecup.git && cd coffeecup
cake build
npm link
cd ~/myproject
npm link coffeecup

2. 项目的使用说明

CoffeeCup 允许您使用 CoffeeScript 编写 HTML 模板。以下是一个简单的示例：

cc = require 'coffeecup'

template = ->
  h1 "这是一个标题"
  p "这是一个段落"

html = cc.render(template)
console.log(html)

在上面的代码中，cc.render 函数接受一个 CoffeeScript 函数作为模板，并返回编译后的 HTML 字符串。

您还可以在模板中使用变量和助手（helpers）：

template = (title) ->
  h1 title
  p "这是一个段落"

helpers =
  textbox: (attrs) ->
    input type: 'text', name: attrs.id, id: attrs.id

html = cc.render(template, title: 'Hello World', hardcode: helpers)
console.log(html)

在上面的示例中，我们通过 hardcode 参数传递了自定义助手。

3. 项目API使用文档

CoffeeCup 的 API 文档可以在其 GitHub 仓库的 API reference 找到。以下是一些常用的 API 方法：

• cc.render(template, [locals]): 渲染模板并返回 HTML 字符串。
• cc.compile(template, [options]): 编译模板并返回一个函数，该函数可以接受本地变量并返回 HTML 字符串。

4. 项目安装方式

除了使用 npm 安装 CoffeeCup 之外，您还可以通过以下方式安装和使用 CoffeeCup：

• 通过 GitHub 克隆仓库：您可以克隆 CoffeeCup 的 GitHub 仓库，并在本地构建和安装。

git clone [e-mail]:gradus/coffeecup.git && cd coffeecup
cake build
npm link

• 在浏览器中使用：CoffeeCup 可以在浏览器中使用，您需要将模板预编译为 JavaScript 函数，并在 HTML 文件中包含这些函数。

这些是使用和安装 CoffeeCup 的基本方法。更多详细信息，请参考项目的 GitHub 仓库和官方文档。