1.1.0 • Published 7 years ago

esdoc v1.1.0

Weekly downloads
76,860
License
MIT
Repository
github
Last release
7 years ago

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

@dsantosmerino/danger-plugin-alex@mcohnen-org/danger-plugin-lint-reportdanger-plugin-commit-lint-angular-js-rulesgameframework-lite@sana-ru/provider-search-render@infinitebrahmanuniverse/nolb-esd@everything-registry/sub-chunk-1598statuscordnumber-backendtaqtile-dangerjs-pluginweave-corewearticlewulv-utils-clixeokit-viewerxeokit-xkt-utilstechnoservssuper-routerstanzarize@create-utils-lib/scripts@bemoje/arr-sortedjbnlapiturris-gulp-taskstuscjstyphonjs-node-esdocutils-scripts@bam.tech/danger-plugin-flow-coverage@bam.tech/danger-plugin-jest-coverage@axway/gulp-tasks1000-packagesydoc-plugin-esdocydoc-plugin-esdoc-basicxooa-sdkuniversal-js-boilerplate@eastsideco/escshopify@eluniverso/ads@eluniverso/arcads@loopmode/babel6-base@loopmode/babel7-base@ls-age/ci@mistermarlu/web-crawler@jonyk56/discord.js-parody@kkitahara/esdoc-examples-test-plugin@oeph/danger-plugin-eslint@product-hackers/arcads@rocjs/roc-internal-devmongo-realtime-clientorange-configoxygen-coreohu-scriptsohioparsegraph-reactrazoroccam-testing-corereact-autosizerreact-ai-testreact-maximize-testredux-gridredux-grid-reactredux-grid-testredux-grid-viewqb-ui-componentsreact-formula-testservingjsng6-browserifynextframepixiu-swap-corepixiuswap-libs-sdkredux-pager-testrb-consolereact-pre-testshinobirockstarsmtpapislika-apiskypager-project-frameworkskypager-es6-collectionsgridiron-testgridirongrunt-plugin-esdocgrunt-esdochzzh-utils-scriptsgulp-bundlerifygulp-esdocgulp-esdoc-streamharnosoft-buildhandchequeuiharno-buildion-enginelibvflibwordsmap-dangerbotmajorkinvey-javascript-rackkinvey-javascript-sdk-corereact-web-chat@weave-js/weave-core@verified/libvf@vanruesc/grunt-esdocflaatsfcn-wrtcanimalredux
1.1.0

7 years ago

1.0.4

8 years ago

1.0.3

8 years ago

1.0.2

8 years ago

1.0.1

8 years ago

1.0.0-alpha.8

8 years ago

1.0.0-alpha.7

8 years ago

1.0.0-alpha.6

8 years ago

1.0.0-alpha.5

8 years ago

1.0.0-alpha.4

8 years ago

1.0.0-alpha.3

8 years ago

1.0.0-alpha.2

8 years ago

1.0.0-alpha.1

8 years ago

0.5.2

8 years ago

0.5.1

8 years ago

0.5.0

8 years ago

0.4.8

9 years ago

0.4.7

9 years ago

0.4.6

9 years ago

0.4.5

9 years ago

0.4.4

9 years ago

0.4.3

10 years ago

0.4.2

10 years ago

0.4.1

10 years ago

0.4.0

10 years ago

0.3.1

10 years ago

0.3.0

10 years ago

0.2.6

10 years ago

0.2.5

10 years ago

0.2.4

10 years ago

0.2.3

10 years ago

0.2.2

10 years ago

0.2.1

10 years ago

0.2.0

10 years ago

0.1.4

10 years ago

0.1.3

10 years ago

0.1.2

10 years ago

0.1.1

10 years ago

0.1.0

10 years ago

0.0.2

10 years ago

0.0.1

10 years ago

1.0.0

11 years ago