This is a CLI that generates .md
documentation for interface
s in .ts
source files.
This project does not yet support the following desirable features
.ts
filesshell
cargo install tsmd
Running the following command will create ./input.md
and fill it with a markdown table for each interface
in ./input.ts
.
shell
tsmd -s ./input.ts
When ./input.ts
looks like this,
```typescript export interface Output> { id: string; timestamp: string; data: Omit; }
export interface LowLevelAsset
```
./input.md
will look like the following.
```md
| Field | Type |
| --- | --- |
| timestamp | string
|
| id | string
|
| data | Omit<A, "">
|
| Field | Type |
| --- | --- |
| filenames? | string[]
|
| filename? | string
|
| data | D
|
```