0

ESDoc

ESDoc是JavaScript的良好的文档生成器。(ESDoc is a good documentation generator for JavaScript.)

官方網站
Github 資源庫
主要指標

Github星跟蹤圖

ESDoc是JavaScript的良好的文档生成器。

特性

  • 生成好的文档。
  • 措施文件覆盖。
  • 将测试代码集成到文档中。
  • 将手册集成到文档中。
  • 解析ECMAScript提案。
  • ESDoc托管服务

概覽

名稱與所有者esdoc/esdoc
主編程語言JavaScript
編程語言JavaScript (語言數: 1)
平台
許可證MIT License
發布數34
最新版本名稱1.1.0 (發布於 )
第一版名稱v0.0.1 (發布於 )
創建於2015-03-28 08:00:48
推送於2022-12-07 02:11:37
最后一次提交2018-04-29 19:36:29
星數2.7k
關注者數38
派生數203
提交數873
已啟用問題?
問題數484
打開的問題數152
拉請求數43
打開的拉請求數14
關閉的拉請求數41
已啟用Wiki?
已存檔?
是復刻?
已鎖定?
是鏡像?
是私有?

Build Status
Coverage Status
Document

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

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

Author

Ryo Maruyama@h13i32maru

去到頂部