Skip to content
ESDoc2 - Better Documentation for JavaScript
JavaScript Shell
Branch: master
Clone or download
Pull request Compare This branch is 82 commits ahead, 37 commits behind esdoc:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github reformat readme and .github docs Nov 11, 2017
manual Fix esdoc2-plugins github links Jan 7, 2018
scripts
src Using console.error instead of console.log for unhandled rejections Dec 12, 2017
test
.babelrc update all deps to latest and refactor logging system Nov 12, 2017
.editorconfig
.esdoc.json set globalIndex to true for gh-page Nov 12, 2017
.eslintignore configure scripts Nov 11, 2017
.eslintrc.js
.gitignore
.nycrc
CHANGELOG.md
LICENSE
README.md Issue #7 Dec 13, 2017
circle.yml add nyc to package.json test ci script Nov 12, 2017
package.json v2.1.5 Jun 13, 2018
yarn.lock

README.md

Build Status Coverage Status Document Coverage Status

ESDoc2

ESDoc2 is a drop-in replacement of ESDoc, a documentation generator for JavaScript. ESDoc2 was created as the result of the original author of ESDoc refusing to add any other contributors to the project. ESDoc2 is the decentralized version, contributors and maintainers are welcome.

Features

  • Generates good documentation.
  • Measures documentation coverage.
  • Integrate test codes into documentation.
  • Integrate manual into documentation.
  • Parse ECMAScript proposals.
  • Lots of plugins

Quick Start

# Move to your project directory.
cd your-project/

# Install esdoc2 and standard plugin.
npm install esdoc2 esdoc2-standard-plugin

# Create a configuration file.
echo '{
  "source": "./src",
  "destination": "./docs",
  "plugins": [{"name": "esdoc2-standard-plugin"}]
}' > .esdoc.json

# Run esdoc2.
./node_modules/.bin/esdoc2

# View documentation
open ./docs/index.html

Documentation

Please visit esdoc2.org to see more documentation.

License

MIT

Acknolwedgements

  • Ryo Maruyama, author of ESDoc
You can’t perform that action at this time.