esdoc
    Overview
    Documentation
    Tutorials
    Insights
    Code
    Dependencies
    Contributors
    Jobs

esdoc

Good Documentation Generator For JavaScript

1.1.0  •  Updated 2 years ago  •  by esdoc  •  MIT License

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

Popularity

Weekly Downloads
37.0K
Stars
2.5K

Maintenance

Development

Last ver 2 years ago
Created 5 years ago
Last commit 2 years ago
1 day between commits

Technology

Node version: 8.11.1
131.5K unpacked

Compliance

MIT License
OSI Approved
0 vulnerabilities

Contributors

40 contributors
Ryo Maruyama
Maintainer, 669 commits, 43 merges, 3 PRs
Works at Cookpad inc.
Ryo Maruyama
156 commits
Stefan Walther
8 commits, 2 PRs
Hyunje Alex Jun
4 commits, 2 PRs
Works at google
Vladimir Timofeev
4 commits, 1 PRs
Works at Self employed
kdex
2 commits, 1 PRs

Tags

jsdoc
api
document
documentation
ES6
ECMAScript6
ES2015
ECMAScript2015
ES7
ECMAScript7
ES2016
ECMAScript2016
ES8
ECMAScript8
ES2017
ECMAScript2017
proposal
Openbase helps developers choose among and use millions of open-source packages, so they can build amazing products faster.
FacebookTwitterLinkedIn
© 2020 Devstore, Inc.