子文档清单 doc.docdoc.json

位于子文档目录根(与语言目录同级),声明该子文档自身的标题、语言支持与缺省侧栏渲染器。站点清单 docdoc.json 的 docs 数组负责把目录登记为子文档,本文件负责子文档的呈现细节。

必须列出该文档支持的全部语言:仅在声明了某语言且磁盘上存在 <path>/<语言>/ 目录时,该语言下才出现此文档。

字段

字段 类型 必填 说明
title object 是 Tab 栏显示名 i18n:{语言码: 显示名}
languages object 是 该文档支持的全部语言:{语言码: 显示名}
renderer string 否 文档级缺省侧栏渲染器:tree(缺省,可展开折叠)、submenu(逐级进入)或 group(分组标签 + 恒展开)

renderer 只是缺省值:各目录可用自己的 metadata.docdoc.json 覆盖(站内搜索 ?metadata.docdoc.json);submenu 形态下当前层级的直属子目录一律呈现为点击进入条目,子目录声明的形态在进入该目录后的侧栏页面中生效。

示例

{
  "title": { "cn": "User Manual" },
  "languages": { "cn": "简体中文" },
  "renderer": "submenu"
}