Socket
Socket
Sign inDemoInstall

esdoc

Package Overview
Dependencies
137
Maintainers
1
Versions
41
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    esdoc

Good Documentation Generator For JavaScript


Version published
Weekly downloads
46K
decreased by-4.46%
Maintainers
1
Install size
14.1 MB
Created
Weekly downloads
 

Changelog

Source

0.5.1 (2016-12-26)

  • Fix
    • Fix a message when could not parse the codes (a98a83c)
    • Fix a help message (a16e2c1)

Readme

Source

Build Status Coverage Status Document Manual

ESDoc

ESDoc is a documentation generator for JavaScript(ES2015 or later).

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

# install ESDoc from npm
npm install -g esdoc

# move to a your project directory
cd your-project/

# write a configuration file.
echo '{"source": "./src", "destination": "./doc"}' > .esdoc.json

# run ESDoc
esdoc

# see a documentation
open ./doc/index.html

Document

please visit esdoc.org to see more documentation.

roadmap of v1.0.0

License

MIT

Author

Ryo Maruyama@h13i32maru

Keywords

FAQs

Last updated on 26 Dec 2016

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc