Interface TemplateData

外观模板函数的输入契约:renderLayout(data: TemplateData) 的全部拼装依据。

Name Data Type Optional Description
siteTitle string No 站点名,Header 与页面标题后缀
icon string No 站点图标,data URI / URL / 文本,空字符串时使用 Phosphor 文档默认图标
lang string No 当前页语言代码,纯 Markdown 格式为空字符串
langs object[] No 语言列表,元素含 code、label,仅多于一种时渲染语言切换器
docs object[] No 当前语言可用的子文档列表,元素含 name、title(按当前语言解析)、renderer(tree / submenu / group,为文档级缺省渲染器),多于一个时渲染顶部 Tab 栏
currentDoc object | null No 当前页所属子文档(含 name、title、renderer),语言落地页与单文档布局为 null
navForm string No 本页最终生效的侧栏渲染器(tree / submenu / group):所在目录链最深一级 metadata.docdoc.json 的 renderer 优先,回落到 doc.docdoc.json,最终回落 tree
submenu object | null No submenu 形态侧栏数据:crumbs(面包屑链,元素含 title、path、iconName)与 items(当前目录条目,首位为目录首页的同标题条目,文档根层级除外),仅 navForm 为 submenu 时提供,否则为 null
rootPrefix string No 当前页指回站点根的前缀
path string No 当前页相对站点根的路径
title string No 当前页标题,已剥离标题标签与扩展名
contentHtml string No 管线产出的内容 HTML
tree object[] No 当前子文档的目录树,Sidebar 数据源,节点含 title、path、tags、children、iconName(标题 <Icon> 声明的图标名,可选)
outline object[] No 当前页标题大纲,Minimap 数据源,元素含 id、level、text
prev object | null No 上一页,含 path、title;目录序中无上一页时为 null
next object | null No 下一页,含 path、title;目录序中无下一页时为 null
copyright string No 页脚版权文本,来自 docdoc.json 顶层 copyright;空串时页脚回退 © 年份 + 站点名
builtAt string No 构建完成时间,构建机本地时区格式(YYYY-MM-DD HH:mm:ss UTC±hh:mm),Footer 展示