Index Generate Search FAQ

Goal

Gather all JavaScript documentations into one place

What is ESDoc?

ESDoc is a good documentation generator for JavaScript.
For more information is esdoc.org

How to update documentation via hands

Update with your hand at here

How to update documentation via API

You can update documentation using API. A sample script is here

Documentation Coverage Badge

You can use documentation coverage badge.

https://doc.esdoc.org/github.com/user-name/repo-name/badge.svg
https://doc.esdoc.org/github.com/user-name/repo-name/manual-badge.svg

Support repositories

Now, supports only GitHub.

Support ECMAScript Proposal

You can see Feature: ECMAScript Proposal.

Can not use property in config

Can not use the following property.
- scripts
- styles

And plugins is limited used.
- esdoc-importpath-plugin

Zero config hosting(without esdoc.json)

If your repository satisfy the following conditions, enable zero config hosting(without esdoc.json).
- ES2015 codes are exist in /src directory
- /package.json is exist

Feedback

Please report using GitHub Issue