@enterthenamehere/esdoc

This is an updated version of esdoc. It uses babel 7, so it can parse most modern code including TypeScript and Flow.

Please use updated plugins too. It is not compatible with original esdoc.

Main changes:

• updated dependencies
• updated to babel 7
• replaced code-prettify with highlightjs
• ecmascript-proposal plugin is now part of standard-plugin

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

• ESDoc (self-hosting 😄)
• RxJS
• Sketch API

And more.

Quick Start

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

# Install ESDoc and standard plugin.
npm install --save-dev @enterthenamehere/esdoc @enterthenamehere/esdoc-standard-plugin

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

# Run ESDoc.
esdoc
or
./node_modules/@enterthenamehere/esdoc

# View a documentation
open ./docs/index.html

Document

please visit esdoc.org to see more documentation.

License

MIT

Author

Ryo Maruyama@h13i32maru