Skip to content

Latest commit

 

History

History
32 lines (22 loc) · 1.39 KB

File metadata and controls

32 lines (22 loc) · 1.39 KB

DocMan 配置文件

DocMan 配置文件 docman.config.json 是设置 DocMan 文档目录(输入目录),发行目录(输出目录),渲染模式等参数的文件,控制 DocMan 的生成行为。

必须有一个 docman.config.json 位于项目根目录中。

例如:

{
	"inputDir": "./docs",

	"outputDir": "./dist",

	"themeDir": "./themes/docman-theme-classic"
}

基本配置

名称
inputDir 文档项目目录(输入目录),默认是 ./docs
outputDir 发行目录(输出目录),默认是 ./dist
themeDir 主题文件夹,默认使用 ./themes/docman-theme-classic

扩展配置

名称
renderMode
当前版本不支持
可选项:
1. server-cold(默认值) - 服务端冷渲染,服务器一次性渲染所有文档文件并输出至发行目录,然后可用 Nginx 部署发行目录;
2. server - 服务端冷渲染,server-cold 的缩写;
3. server-hot - 服务端热渲染,服务器在收到 HTTP 请求后才开始渲染文档文件,在这种模式下,DocMan 将在指定端口上启动 HTTP 服务器,需要配置 Nginx 反向代理至该端口;
4. client - 客户端 AJAX 渲染,浏览器先拿到模板页面,通过 AJAX 获取数据后再填入模板中。
alsoDo 完成任务后执行的附加任务队列