# tsdoc2md.torn

> convert typescript comments to markdown file

Latest version **0.0.20-alpha** (published 2019-09-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install tsdoc2md.torn
pnpm add tsdoc2md.torn
yarn add tsdoc2md.torn
bun add tsdoc2md.torn
```

Provides the command `tsdoc2md`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.20-alpha |
| Published | 2019-09-08 |
| First published | 2019-09-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 76.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | yiddot |
| Maintainers | torns |
| Keywords | tsdoc, markdown |

## Links

- npm: https://www.npmjs.com/package/tsdoc2md.torn
- Repository: https://github.com/yiidot/tsdoc2md
- Homepage: https://github.com/yiidot/tsdoc2md#readme
- Issues: https://github.com/yiidot/tsdoc2md/issues
- npm.io page: https://npm.io/package/tsdoc2md.torn

## Dependencies (4)

- [chalk](https://npm.io/package/chalk.md) ^2.4.2
- [lodash](https://npm.io/package/lodash.md) ^4.17.15
- [@microsoft/api-extractor](https://npm.io/package/@microsoft/api-extractor.md) ^7.3.4
- [@microsoft/node-core-library](https://npm.io/package/@microsoft/node-core-library.md) ^3.13.0

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 0.0.20-alpha (latest) — 2019-09-08
- 0.0.20 — 2019-09-08
- 0.0.13 — 2019-09-08

## README

# tsdoc2md

### convert typescript comments to markdown file.
Comments converting of Class, Property, Constructor and Method is implemented.
More will come up soon.

Only support annotations @param, @returns, @example.

Please follow typescript doc comment syntax: [Doc comment syntax](https://api-extractor.com/pages/tsdoc/doc_comment_syntax/)

## Demo
[tsdoc2md-demo](https://github.com/yiidot/tsdoc2md-demo.git)

## Install
```
npm install -g tsdoc2md
```

## Usage
### step1
generate config file named 'tsdoc2md.json'
```js
// tsdoc2md.json
{
  "entry": {
    "README": "/lib/index.d.ts"
  },
  "outDir": "/docs/"
}
/**
* 1. key of entry will be name of markdown file.
* 2. entry file should be a declaration file. 
*/
```
your tsconfig shoud be:
```js
// tsconfig.json
{
  ...
  "declaration": true,
  "declarationMap": true,
  "outDir": "lib"
  ...
}
```
### step2
execute command
```shell
# use in terminal
tsdoc2md
```

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