# ye-ts2doc

> transform ts to api doc

Latest version **1.0.1** (published 2021-08-16) · ISC license · 0 weekly downloads

## Install

```sh
npm install ye-ts2doc
pnpm add ye-ts2doc
yarn add ye-ts2doc
bun add ye-ts2doc
```

Provides the command `ts2doc`.

## 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.0.1 |
| Published | 2021-08-16 |
| First published | 2021-08-16 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 11.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | aaron |
| Maintainers | yejianjian |

## Links

- npm: https://www.npmjs.com/package/ye-ts2doc
- Repository: https://github.com/AaronY666/ye-ts2doc/tree/master
- npm.io page: https://npm.io/package/ye-ts2doc

## Dependencies (5)

- [doctrine](https://npm.io/package/doctrine.md) ^3.0.0
- [fs-extra](https://npm.io/package/fs-extra.md) ^10.0.0
- [@babel/core](https://npm.io/package/@babel/core.md) ^7.15.0
- [@babel/parser](https://npm.io/package/@babel/parser.md) ^7.15.3
- [@babel/helper-plugin-utils](https://npm.io/package/@babel/helper-plugin-utils.md) ^7.14.5

## Recent versions

- 1.0.1 (latest) — 2021-08-16
- 1.0.0 — 2021-08-16

## README

# ye-ts2doc
This project can help you generate api doc as markdown ,by reading the notes from ts files.

![GitHub package.json version](https://img.shields.io/github/package-json/v/AaronY666/ye-ts2doc?style=plastic)
![npm](https://img.shields.io/npm/v/ye-ts2doc)
### Instalation
```shell
npm install ye-ts2doc -D
```
### Usage
In just two steps, you can convert ts files into API documentation
#### create config
To use ye-ts2doc, you should firstly create the `ts2doc.config.js` under you project.
```js
//ts2doc.config.js
const path = require("path")
module.exports = {
    input: <the file path that the ts file you want to parse>,
    output: <the output path the markdown file generated>,
    filename: <the name of the output markdown file>,
    publicOnly: <if only parse public methods or properties>,
}
```
#### start parse
Next, execute the following command
```shell
ts2doc
```
now , you can find markdown file in you output file!

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