渲染器 | Hexo

渲染器用于渲染内容。

概要

hexo.extend.renderer.register(
  name,
  output,
  function (data, options) {
    // ...
  },
  sync,
);

参数	描述
`name`	输入的扩展名（小写，不含开头的 `.`）
`output`	输出的扩展名（小写，不含开头的 `.`）
`sync`	同步模式

渲染函数中会传入三个参数：

参数	描述
`data`	包含两个属性：文件路径 `path` 和文件内容 `text`。 `path` 不一定存在。
`option`	选项
`callback`	包含两个参数 `err`, `value` 的回调函数

示例

异步模式

var stylus = require("stylus");

// Callback
hexo.extend.renderer.register(
  "styl",
  "css",
  function (data, options, callback) {
    stylus(data.text).set("filename", data.path).render(callback);
  },
);

// Promise
hexo.extend.renderer.register("styl", "css", function (data, options) {
  return new Promise(function (resolve, reject) {
    resolve("test");
  });
});

同步模式

var ejs = require("ejs");

hexo.extend.renderer.register(
  "ejs",
  "html",
  function (data, options) {
    options.filename = data.path;
    return ejs.render(data.text, options);
  },
  true,
);

禁用 Nunjucks 标签

Nunjucks 标签 {{ }} 或 {% %} (被标签插件所使用) 默认会被处理，想要禁用：

function lessFn(data, options) {
  // do something
}

lessFn.disableNunjucks = true;

hexo.extend.renderer.register("less", "css", lessFn);