Popularity
6.7
Growing
Activity
0.0
Stable
2,533
37
197

Code Quality Rank: L2
Monthly Downloads: 28,551
Programming language: JavaScript
License: MIT License
Tags: Es6     API     Jsdoc     ECMAScript2015     ECMAScript6     ES2015     Document    
Latest version: v1.1.0

ESDoc alternatives and similar modules

Based on the "Documentation" category

Do you think we are missing an alternative of ESDoc or a related project?

Add another 'Documentation' Module

README

<!--Owner Status--> 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


*Note that all licence references and agreements mentioned in the ESDoc README section above are relevant to that project's source code only.