tsmd

目的

这是一个 CLI 工具，用于从 .md 源文件生成 interface 的文档。

限制

此项目尚未支持以下期望的功能

• 将非接口声明解析为有意义的文档
• 将泛型参数和约束解析为有意义的文档
• 允许源 .ts 文件向量

安装 & 指南

cargo install tsmd

运行以下命令将创建 ./input.md 并填充每个 interface 在 ./input.ts 中的 Markdown 表格。

tsmd -s ./input.ts

当 ./input.ts 看起来像这样时，

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 将看起来像以下。

## Output

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

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