Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/esdoc/esdoc

ESDoc - Good Documentation for JavaScript
https://github.com/esdoc/esdoc

ast es2015 esdoc javascript jsdoc

Last synced: about 1 month ago
JSON representation

ESDoc - Good Documentation for JavaScript

Lists

README 

        

[![Build Status](https://travis-ci.org/esdoc/esdoc.svg?branch=master)](https://travis-ci.org/esdoc/esdoc)

[![Coverage Status](https://codecov.io/gh/esdoc/esdoc/branch/master/graph/badge.svg)](https://codecov.io/gh/esdoc/esdoc)

[![Document](https://doc.esdoc.org/github.com/esdoc/esdoc/badge.svg?t=0)](https://doc.esdoc.org/github.com/esdoc/esdoc)



# 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](https://doc.esdoc.org)



# Users

- [ESDoc](https://doc.esdoc.org/github.com/esdoc/esdoc/) (self-hosting 😄)

- [RxJS](http://reactivex.io/rxjs/)

- [Sketch API](http://developer.sketchapp.com/reference/api/)



And [more](https://github.com/search?o=desc&q=esdoc+filename%3Apackage.json+-user%3Ah13i32maru+-user%3Aesdoc+-user%3Aes-doc&ref=searchresults&s=indexed&type=Code&utf8=%E2%9C%93).



# Quick Start

```sh

# 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](https://esdoc.org) to see more documentation.



# License

MIT



# Author

[Ryo Maruyama@h13i32maru](https://twitter.com/h13i32maru)