Mu - 一个快速的 Node.js Mustache 引擎使用技术文档

本文档将为您详细介绍如何安装、使用以及 Mu 项目 API 的相关内容。

1. 安装指南

由于项目维护者遇到了 npm 认证问题，目前您需要使用以下命令进行安装：

npm install mu2

2. 项目使用说明

Mu 是一个快速的 Node.js Mustache 引擎。以下是一些使用 Mu 的简单示例。

基本使用

var mu = require('mu2'); // 注意这里的 "2"，与 npm 仓库匹配

mu.root = __dirname + '/templates';
mu.compileAndRender('index.html', {name: "john"})
  .on('data', function (data) {
    console.log(data.toString());
  });

结合 HTTP 模块使用

var http = require('http')
  , util = require('util')
  , mu   = require('mu2');

mu.root = __dirname + '/templates';

http.createServer(function (req, res) {
  var stream = mu.compileAndRender('index.html', {name: "john"});
  stream.pipe(res);
}).listen(8000);

开发模式下使用

以下是一个技巧，用于在开发模式下始终编译模板（以便立即反映更改）：

var http = require('http')
  , util = require('util')
  , mu   = require('mu2');

mu.root = __dirname + '/templates';

http.createServer(function (req, res) {
  if (process.env.NODE_ENV == 'DEVELOPMENT') {
    mu.clearCache();
  }

  var stream = mu.compileAndRender('index.html', {name: "john"});
  util.pump(stream, res);
}).listen(8000);

3. 项目 API 使用文档

以下是 Mu 项目的 API 文档。

• mu.root: 模板查找的路径。默认为当前工作目录。

• mu.compileAndRender(String templateName, Object view): 返回一个 Stream。首次调用此函数时，将编译指定名称的模板并渲染到 Stream。后续使用相同模板名称的调用将使用缓存的编译版本以提高性能。

• mu.compile(filename, callback): 返回 null。此函数用于编译模板。通常您不需要直接使用它，但在执行一些特殊操作时，这可能对您有帮助。多次调用时不会使用内部缓存，但会将编译后的形式添加到缓存中。

• mu.compileText(String name, String template, Function callback): 返回 null。与 mu.compile 类似，但接收一个名称和模板的实际字符串。不进行磁盘 I/O 操作，也不会自动编译部分模板。

• mu.render(Mixed filenameOrCompiledTemplate, Object view): 返回 Stream。此函数接受先前编译（在缓存中）的模板名称或 mu.compile 的结果。

• mu.renderText(String template, Object view, Object partials): 返回 Stream。与 render 类似，但接收一个模板字符串和一个部分对象。这不是使用 Mu 的最高效方式，因此仅在开发/测试时使用。

• mu.clearCache(String templateNameOrNull): 清除特定模板的缓存。如果省略名称，则清除所有缓存。

4. 项目安装方式

请使用以下命令安装 Mu：

npm install mu2

以上内容为您提供了 Mu 项目的安装、使用和 API 文档。希望这些信息能帮助您更好地使用 Mu 项目。