https://github.com/esdoc/esdoc

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

ast es2015 esdoc javascript jsdoc

Last synced: 5 days ago
JSON representation

ESDoc - Good Documentation for JavaScript

• Host: GitHub
• URL: https://github.com/esdoc/esdoc
• Owner: esdoc
• License: mit
• Created: 2015-03-28T08:00:48.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2024-08-14T11:10:32.000Z (5 months ago)
• Last Synced: 2024-10-29T15:05:41.807Z (2 months ago)
• Topics: ast, es2015, esdoc, javascript, jsdoc
• Language: JavaScript
• Homepage: https://esdoc.org
• Size: 9.82 MB
• Stars: 2,738
• Watchers: 38
• Forks: 205
• Open Issues: 167
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome - esdoc - ESDoc - Good Documentation for JavaScript (JavaScript)
• awesome-nodejs-cn - ESDoc - 面向 ES2015 的文档生成器，附加测试代码并评估文档覆盖范围 (包 / 文档相关)
• awesome-nodejs - ESDoc - Documentation generator targeting ES2015, attaching test code and measuring documentation coverage.  (Repository / Documentation)
• awesome-nodejs - esdoc - ESDoc - Good Documentation for JavaScript - ★ 2240 (Documentation)
• awesome-node - ESDoc - Documentation generator targeting ES2015, attaching test code and measuring documentation coverage. (Packages / Documentation)
• awesome-nodejs-cn - ESDoc - 针对ES2015的文档生成器，附加测试代码并衡量文档覆盖范围. (目录 / 文档生成相关)
• awesome-nodejs - esdoc - JavaScript 的文档生成器 (Uncategorized / Uncategorized)
• awesome-starred - esdoc/esdoc - ESDoc - Good Documentation for JavaScript (javascript)
• awesome-javascript - esdoc - ESDoc - Good Documentation for JavaScript - ★ 2240 (Documentation)

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)