API

本文件提供您更丰富的 API 信息,使您更容易修改 Kuangjia 源代码或编写插件。如果您只是想查询 Kuangjia 的基本使用方法,请参阅 文档

在开始之前,请注意本文件仅适用于 Kuangjia 3 及以上版本。

初始化

首先,我们必须建立一个 Kuangjia 实例(instance),第一个参数是网站的根目录,也就是 base_dir,而第二个参数则是初始化的选项。接著执行 init 方法后,Kuangjia 会加载插件及配置文件。

var Kuangjia = require('kuangjia');
var kuangjia = new Kuangjia(process.cwd(), {});
kuangjia.init().then(function(){
// ...
});
参数 描述 默认值
debug 开启调试模式。在终端中显示调试信息,并在根目录中存储 debug.log 日志文件。 false
safe 开启安全模式。不加载任何插件。 false
silent 开启安静模式。不在终端中显示任何信息。 false
config 指定配置文件的路径。 _config.yml

载入文件

Kuangjia 提供了两种方法来载入文件:load, watch,前者用于载入 source 文件夹内的所有文件及主题资源;而后者除了执行 load 以外,还会继续监视文件变动。

这两个方法实际上所做的,就是载入文件列表,并把文件传给相对应的处理器(Processor),当文件全部处理完毕后,就执行生成器(Generator)来建立路由。

kuangjia.load().then(function(){
// ...
});
kuangjia.watch().then(function(){
// 之后可以调用 kuangjia.unwatch(),停止监视文件
});

执行指令

您可以通过 call 方法来调用控制台(Console),第一个参数是控制台的名称,而第二个参数是选项——根据不同控制台有所不同。

kuangjia.call('generate', {}).then(function(){
// ...
});

结束

当指令完毕后,请执行 exit 方法让 Kuangjia 退出结束前的准备工作(如存储资料库)。

kuangjia.call('generate').then(function(){
return kuangjia.exit();
}).catch(function(err){
return kuangjia.exit(err);
});