# esdoc

> Good Documentation Generator For JavaScript

Latest version **1.1.0** (published 2018-04-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install esdoc
pnpm add esdoc
yarn add esdoc
bun add esdoc
```

Provides the command `esdoc`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2018-04-29 |
| First published | 2015-04-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 6.0.0 |
| Dependencies | 11 |
| Unpacked size | 128.4 KB |
| Known vulnerabilities | 0 (+7 in 4 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2730 |
| Author | h13i32maru |
| Maintainers | h13i32maru |
| Keywords | jsdoc, api, document, documentation, ES6, ECMAScript6, ES2015, ECMAScript2015, ES7, ECMAScript7, ES2016, ECMAScript2016, ES8, ECMAScript8, ES2017, ECMAScript2017, proposal |

## Links

- npm: https://www.npmjs.com/package/esdoc
- Repository: https://github.com/esdoc/esdoc
- Homepage: https://esdoc.org/
- Issues: https://github.com/esdoc/esdoc/issues
- npm.io page: https://npm.io/package/esdoc

## Dependencies (11)

- [marked](https://npm.io/package/marked.md) 0.3.19
- [babylon](https://npm.io/package/babylon.md) 6.18.0
- [cheerio](https://npm.io/package/cheerio.md) 1.0.0-rc.2
- [ice-cap](https://npm.io/package/ice-cap.md) 0.0.4
- [taffydb](https://npm.io/package/taffydb.md) 2.7.3
- [fs-extra](https://npm.io/package/fs-extra.md) 5.0.0
- [minimist](https://npm.io/package/minimist.md) 1.2.0
- [escape-html](https://npm.io/package/escape-html.md) 1.0.3
- [color-logger](https://npm.io/package/color-logger.md) 0.0.6
- [babel-traverse](https://npm.io/package/babel-traverse.md) 6.26.0
- [babel-generator](https://npm.io/package/babel-generator.md) 6.26.1

## Alternatives

- [@cantoo/pdf-lib](https://npm.io/package/@cantoo/pdf-lib.md) — 297.9K weekly downloads
- [datatables.net-buttons](https://npm.io/package/datatables.net-buttons.md) — 200.1K weekly downloads
- [@ckeditor/ckeditor5-export-pdf](https://npm.io/package/@ckeditor/ckeditor5-export-pdf.md) — 167.0K weekly downloads
- [scanbot-web-sdk](https://npm.io/package/scanbot-web-sdk.md) — 15.0K weekly downloads
- [@syncfusion/ej2-angular-pdfviewer](https://npm.io/package/@syncfusion/ej2-angular-pdfviewer.md) — 8.8K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2018-04-29
- 1.0.0-alpha.8 (alpha) — 2017-06-11
- 1.0.4 — 2017-11-12
- 1.0.3 — 2017-09-20
- 1.0.2 — 2017-09-03
- 1.0.1 — 2017-07-30
- 1.0.0-alpha.7 — 2017-06-04
- 1.0.0-alpha.6 — 2017-05-13
- 1.0.0-alpha.5 — 2017-05-07
- 1.0.0-alpha.4 — 2017-05-07
- 1.0.0-alpha.3 — 2017-04-23
- 1.0.0-alpha.2 — 2017-04-23
- 1.0.0-alpha.1 — 2017-04-23
- 0.5.2 — 2017-01-02
- 0.5.1 — 2016-12-26
- … 26 more at https://npm.io/package/esdoc/versions

## README

<!--![Owner Status](https://img.shields.io/badge/owner-busy-red.svg)-->
[![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.<br/>
Please <a href="https://try.esdoc.org">try it out</a>!

<img class="screen-shot" src="https://raw.githubusercontent.com/esdoc/esdoc/master/manual/asset/image/top.png" width="500px" style="max-width: 500px; border: 1px solid rgba(0,0,0,0.1); box-shadow: 1px 1px 1px rgba(0,0,0,0.5);">

# 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 &#x1F604;)
- [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)

---
_Source: https://npm.io/package/esdoc · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._