正文

前端使用 js doc 生成接口文档

IP云
IP云V管理员/0 阅读
11/12
提示：扫一扫查出行
【扫一扫了解最新限行尾号】
复制提示

docdash

  1. 安装
npm install docdash --save-dev
  1. 在 jsdoc.json 文件中配置
{
  "opts": {
    "template": "node_modules/docdash"
  }
}

预览效果如下：
image

image

找模板的时候，还发现了这个 docdash 主题的折叠版 clean-jsdoc-theme 模板。

相关问答

Q1: clean-jsdoc-theme

这个模板有两种主题，一种是 黑色 dark，一种是灰色 light 更多的配置可以去文档查看
clean-jsdoc-theme文档：https://github.com/pencil-js/clean-jsdoc-theme

  1. 安装
npm install clean-jsdoc-theme --save-dev
  1. 在 jsdoc.json 文件中配置
{
  "opts": {
    "theme_opts": {
      "default_theme": "dark" // or "light" // 修改主题，默认是 dark
    },
    "template": "node_modules/clean-jsdoc-theme"
  }
}

预览效果如下：

  1. dark主题
    image
    image

  2. light 主题
    image
    image

Q2: 自定义模板

自定义模板就是以上的几个模板都不符合要求的话，就需要自定义，设置样式和排版布局等。本人项目中就是使用自定义的，基于 clean-jsdoc-theme 这个模板的代码来进行修改样式和一些侧边栏数据等。

最后附上，完整的 jsdoc.json 文件
image