tsmd

generate markdown tables from TypeScript interfaces

Status

Hobby project in early development for auto-generating docs for TypeScript files.

Todos

• account for generics
• parse non interfaces
• user config

Installation & Guide

cargo install tsmd

Running the following command will create ./input.md and fill it with markdown tables according to the interfaces in ./input.ts.

tsmd -s ./input.ts

When ./input.ts looks like this,

export interface Output<A extends LowLevelAsset<unknown>> {
  id: string;
  timestamp: string;
  data: Omit<A, "">;
}

export interface LowLevelAsset<D> {
  filename?: string;
  filenames?: string[];
  data: D;
}

./input.md will look like the following.

## Output

| Field | Type |
| --- | --- |
| timestamp | `string` |
| id | `string` |
| data | `Omit<A, "">` |
## LowLevelAsset

| Field | Type |
| --- | --- |
| filenames? | `string[]` |
| filename? | `string` |
| data | `D` |