jsdoc 主题模板参考

Posted 2023-04-13

参考技术A

使用npm安装jsdoc后，其文件目录结构如下：

参考： taffydb
而static文件夹放置静态文件，它会被原封不动地复制到生成的文件夹中，tmpl是模板文件

taffyData是包含所有doclet的taffyData，doclet是@link，@name...
比如使用了@name，就可以使用docs[0].name获取第一个@name值

和模板相关的模块是:

生成template的语句是

再看template.js导出类的构造函数

layout的初始化语句：

所以，如果要自定义模板（假设为 selfTheme ，以下都以其为例)的配置项，只需要使用 env.conf.templates 获取即可。例如：

template.js导出类的方法如下：

因此，在 layout.tmpl 文件中，有 content 变量表示当前页内容

当然，同时具有data包含的其它属性变量
在publish.js中，直接使用render函数的有两处。

所以，要修改各页面的标题，只需要将调用这两个函数的title函数换掉，比如：

不过重点还是添加模板变量和方法

添加到view中的方法/属性：

docs是一个包含数据的Taffy对象，它的来源是：

// myClasses等就是传入模板文件的docs变量

在模板中则用this.find(kind: \'class\')代替（view.find）
docs的元素内容是：

特别的：

018_jsdoc详解

一、常用jsdoc命令

jsdoc test.js -c conf.json -d arun      #Reference: https://jsdoc.app/about-commandline.html
jsdoc test.js -c conf.json -d arun --readme 01_2020522day25.md      #添加readme到首页
Reference: https://jsdoc.app/about-including-readme.html