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