ts-readme
Generate docs from typescript and put it in a README
---
- Creates documentation for any exported entity
- Combines JSDoc + TypeScript annotations
- Includes parameters, return types, descriptions, and even example blocks
## Installation
```sh
npm i ts-readme
# with yarn
yarn add ts-readme
```
## Usage
Simply run `ts-readme` and it will pick up all the typescript files in your `src` folder and generate docs.
```json
{
"scripts": {
"generate-docs": "ts-readme"
}
}
```
And insert this block of code somewhere in your `README.md`:
```md
```
### Help
If you need any docs on `ts-readme` simply run the following from your terminal:
```sh
npx ts-readme --help
```
### Targeting more files
`ts-readme` also supports targeting other files that might not be in `src`.
Simply provide a glob to `ts-readme` and it will also generate docs for those files.
```json
{
"scripts": {
"generate-docs": "ts-readme components/**/*.(ts|tsx)"
}
}
```
### Node API
You can use `ts-readme` as a normal node package too!
This gives you finer grain control of where your docs are inserted!
#### `generateMarkdown` (function)
Generate the markdown docs a doc returned from `getAllDocs`
**Parameters:**
- doc (`TypeScriptDocument`) - The TypeScript document to generate types for
- headerDepth (`number`)
**returns:** string
#### `getAllDocs` (function)
Get the docs for all some files in the project.
**Parameters:**
- pattern (`string | string[]`) - A glob pattern or patterns to match files from
**returns:** Promise