# typedocs

> A library that generates JSON documentation for TypeScript code by correlating the TypeScript typing with JsDocs comments.

Latest version **0.6.7** (published 2019-12-18) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.6.7 |
| Published | 2019-12-18 |
| First published | 2016-08-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 431.5 KB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Alvaro Dias |
| Maintainers | alvarorahul |
| Keywords | TypeScript, documentation, JsDocs, javascript |

## Links

- npm: https://www.npmjs.com/package/typedocs
- Repository: https://github.com/alvarorahul/TypeDocs
- Homepage: https://github.com/alvarorahul/TypeDocs/blob/master/README.md
- Issues: https://github.com/alvarorahul/TypeDocs/issues
- npm.io page: https://npm.io/package/typedocs

## Dependencies (2)

- [marked](https://npm.io/package/marked.md) ^0.7.0
- [typescript](https://npm.io/package/typescript.md) 3.2.4

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 0.6.7 (latest) — 2019-12-18
- 0.6.6 — 2019-05-09
- 0.6.5 — 2018-04-07
- 0.6.4 — 2018-04-06
- 0.6.3 — 2016-10-08
- 0.6.2 — 2016-10-03
- 0.6.1 — 2016-10-02
- 0.6.0 — 2016-09-30
- 0.5.0 — 2016-09-25
- 0.4.0 — 2016-09-18
- 0.3.5 — 2016-08-26
- 0.3.4 — 2016-08-25

## README

# TypeDocs

[![Build Status](https://travis-ci.org/alvarorahul/TypeDocs.png?branch=master)](https://travis-ci.org/alvarorahul/TypeDocs)
[![npm version](https://badge.fury.io/js/typedocs.svg)](https://badge.fury.io/js/typedocs)
[![Coverage Status](https://coveralls.io/repos/github/alvarorahul/TypeDocs/badge.svg?branch=master)](https://coveralls.io/github/alvarorahul/TypeDocs?branch=master)
[![TypeDocs license](https://img.shields.io/npm/l/typedocs.svg)](https://github.com/alvarorahul/TypeDocs)
[![GitHub tag](https://img.shields.io/github/tag/alvarorahul/typedocs.svg)](https://github.com/alvarorahul/TypeDocs)

TypeDocs is a library that helps generate API documentation for TypeScript code.

## Installing

```
npm install typedocs
```

## Usage

To get documentation programmatically, you can invoke this library
programmatically as follows: -

```ts
import * as typedocs from "typedocs";

"use strict";

const sourceFileName = "path/to/declaration.d.ts";

// Generate documentation by calling the generate function
// passing in the definition files.
const result = typedocs.generate([sourceFileName]);

// Optionally you can flatten the modules to include
// separate items for nested modules.
const flatResult = typedocs.flattenModules(result);
```

To generate a docs website, execute the following: -

```ts
import * as typedocs from "typedocs";

"use strict";

const sourceFileName = "path/to/declaration.d.ts";

// Generate documentation by calling the generate function
// passing in the definition files.
const result = typedocs.generate([sourceFileName], {
    websiteOptions: {
        dir: "./myproductwebsite",
        resources: {
            productName: "My awesome product",
            productDescription: "The description for my awesome product.",
        }
    }
});
```

## Sample

The samples folder contains an app that demonstrates the usage above. You can
run the below command to exercise it.

```
node sampleapp.js
```

## Contributing

To contribute to the project please go through the
[Contributing.md](Contributing.md) guide.

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