5

使用 ESDoc 生成文档 - rxliuli blog

 4 years ago
source link: https://blog.rxliuli.com/p/ba2aa72859434d07b05a832faa058add/
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
neoserver,ios ssh client

esdoc 官网, 博客地址, 示例项目

在尝试过使用 markdown, jsdoc, docz 之后，吾辈终于找到了一个比较满意工具 – esdocs。

  • 开箱即用: 毫无疑问, js 正在把一切事情变得复杂，到处都是大量的配置，永远都学不会开箱即用
  • 支持 jsdoc 注释: 已经熟悉了 jsdoc，所以不太希望切换到其他的注释规范了呢
  • 可配置自定义页: 作为文档 API 列表还算合适，然而首页的话果然还是自定义最好

因为以上的期望，吾辈最终选择了 esdocs。

1
yarn add -D esdoc esdoc-standard-plugin

初始化配置

创建一个配置文件 .esdoc.json

1
2
3
4
5
{
  "source": "./src",
  "destination": "./docs",
  "plugins": [{ "name": "esdoc-standard-plugin" }]
}

当然，如果你使用的命令行是 bash/git-for-bash/cmder 的话，亦可使用命令快速完成

1
2
3
4
5
echo '{
  "source": "./src",
  "destination": "./docs",
  "plugins": [{"name": "esdoc-standard-plugin"}]
}' > .esdoc.json

在 package.json 中添加一个打包文档的 script 命令

1
2
3
"scripts": {
  "docs": "esdoc"
}

然后使用 yarn docs 命令即可打包一份新鲜可用的文档啦

然后打开 docs/index.html 文件即可查看了，下面截张吾辈的工具库 rx-util 生成的文档。

感觉是不是很简单，吾辈也是这样认为的呢！后面会整理一份 jsdoc 的标签列表，便于快速查找与一览。


report

Recommend

About Joyk


Aggregate valuable and interesting links.
Joyk means Joy of geeK