ESDoc是JavaScript的良好的文档生成器。
特性
- 生成好的文档。
- 措施文件覆盖。
- 将测试代码集成到文档中。
- 将手册集成到文档中。
- 解析ECMAScript提案。
- ESDoc托管服务
ESDoc
ESDoc是JavaScript的良好的文档生成器。(ESDoc is a good documentation generator for JavaScript.)
Github星跟踪图
主要指标
- 概览
-
名称与所有者 esdoc/esdoc 主编程语言 JavaScript 编程语言 JavaScript (语言数: 1) 平台 许可证 MIT License - 所有者活动
-
创建于 2015-03-28 08:00:48 推送于 2024-08-14 11:10:32 最后一次提交 2018-04-29 19:36:29 发布数 34 最新版本名称 1.1.0 (发布于 ) 第一版名称 v0.0.1 (发布于 ) - 用户参与
-
星数 2.7k 关注者数 35 派生数 201 提交数 873 已启用问题? 问题数 484 打开的问题数 151 拉请求数 43 打开的拉请求数 15 关闭的拉请求数 41 - 项目设置
-
已启用Wiki? 已存档? 是复刻? 已锁定? 是镜像? 是私有?
ESDoc
ESDoc is a documentation generator for JavaScript.
Please try it out!
Features
- Generates good documentation.
- Measures documentation coverage.
- Integrate test codes into documentation.
- Integrate manual into documentation.
- Parse ECMAScript proposals.
- ESDoc Hosting Service
Users
- ESDoc (self-hosting 😄)
- RxJS
- Sketch API
And more.
Quick Start
# Move to a your project directory.
cd your-project/
# Install ESDoc and standard plugin.
npm install --save-dev esdoc esdoc-standard-plugin
# Create a configuration file.
echo '{
"source": "./src",
"destination": "./docs",
"plugins": [{"name": "esdoc-standard-plugin"}]
}' > .esdoc.json
# Run ESDoc.
./node_modules/.bin/esdoc
# View a documentation
open ./docs/index.html
Document
please visit esdoc.org to see more documentation.
License
MIT