🌜
🌞
esdoc

esdoc

v1.1.0

Good Documentation Generator For JavaScript

npm install esdoc

README

Build Status Coverage Status Document

ESDoc

ESDoc is a documentation generator for JavaScript.
Please try it out!

esdoc

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 [email protected]

Release Notes

1.1.0
By Ryo Maruyama • Published on April 29, 2018
1.0.3
By Ryo Maruyama • Published on September 20, 2017
1.0.2
By Ryo Maruyama • Published on September 3, 2017
1.0.1
By Ryo Maruyama • Published on July 30, 2017
0.5.2
By Ryo Maruyama • Published on January 2, 2017
0.5.1
By Ryo Maruyama • Published on December 26, 2016
0.5.0
By Ryo Maruyama • Published on December 25, 2016
0.4.8
By Ryo Maruyama • Published on August 7, 2016
0.4.7
By Ryo Maruyama • Published on May 1, 2016
0.4.6
By Ryo Maruyama • Published on March 6, 2016

General

License
MIT
Typescript Types
None found
Tree-shakeable
No

Popularity

GitHub Stargazers
2,723
Community Interest
2,998
Number of Forks
216

Maintenance

Commits
10/219/2201
Last Commit
Apr 29, 2018
Open Issues
149
Closed Issues
331
Open Pull Requests
12
Closed Pull Requests
41

Versions

Versions Released
10/219/2201
Latest Version Released
Apr 29, 2018
Current Tags
latest1.1.0
alpha1.0.0-alpha.8

Contributors

h13i32maru
h13i32maru
Commits: 615
vovkasm
vovkasm
Commits: 4
hatashiro
hatashiro
Commits: 4
kdex
kdex
Commits: 2
togana
togana
Commits: 2
skratchdot
skratchdot
Commits: 1
existentialism
existentialism
Commits: 1
atsushieno
atsushieno
Commits: 1
mprobber
mprobber
Commits: 1
ProLoser
ProLoser
Commits: 1
amercier
amercier
Commits: 1
koba04
koba04
Commits: 1
bmaupin
bmaupin
Commits: 1
hiroppy
hiroppy
Commits: 1
Kuniwak
Kuniwak
Commits: 1