Skip to content
This repository has been archived by the owner on Jan 17, 2023. It is now read-only.

Latest commit

 

History

History
43 lines (32 loc) · 1.04 KB

README.md

File metadata and controls

43 lines (32 loc) · 1.04 KB

ESDoc

ESDoc is a documentation generator for JavaScript.

Features

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

Users

  • Submit a PR if you switch to using this fork! :)

Quick Start

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

# Install ESDoc and standard plugin.
npm install --save-dev @itsjamie/esdoc-core @itsjamie/esdoc-cli @itsjamie/esdoc-standard-plugin

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

# Run ESDoc.
npx esdoc

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

License

MIT

Author

Ryo Maruyama@h13i32maru