ESDoc是JavaScript的良好的文档生成器。
特性
- 生成好的文档。
- 措施文件覆盖。
- 将测试代码集成到文档中。
- 将手册集成到文档中。
- 解析ECMAScript提案。
- ESDoc托管服务
ESDoc
ESDoc是JavaScript的良好的文档生成器。(ESDoc is a good documentation generator for JavaScript.)
Github stars Tracking Chart
Main metrics
- Overview
-
Name With Owner esdoc/esdoc Primary Language JavaScript Program language JavaScript (Language Count: 1) Platform License: MIT License - 所有者活动
-
Created At 2015-03-28 08:00:48 Pushed At 2024-08-14 11:10:32 Last Commit At 2018-04-29 19:36:29 Release Count 34 Last Release Name 1.1.0 (Posted on ) First Release Name v0.0.1 (Posted on ) - 用户参与
-
Stargazers Count 2.7k Watchers Count 35 Fork Count 201 Commits Count 873 Has Issues Enabled Issues Count 484 Issue Open Count 151 Pull Requests Count 43 Pull Requests Open Count 15 Pull Requests Close Count 41 - 项目设置
-
Has Wiki Enabled Is Archived Is Fork Is Locked Is Mirror Is Private
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