typescript-doc-gen v1.0.16

typescript-doc-gen

一个快速将 TSX interface 转成 Markdown 的命令行工具

如何开始

npm install -g typescript-doc-gen
doc-gen
# 将`src\\Sample\\index.tsx`文件的interface提取出Markdown，默认保存到当前目录out下，注意在`.gitignore`文件里面添加out目录
doc-gen generate src\\Sample\\index.tsx

# or 将`src\\Sample\\index.tsx`文件的interface提取出Markdown 并保存到桌面
doc-gen generate src\\Sample\\index.tsx D:\\Users\\admin\\Desktop

功能

• 识别 interface
• 识别 extends，将其内容转化为子表格
• 识别自定义类型，将其转化为子表并内链

来喷源码

git clone git@gitlab.zmaxis.com:rongfu.zhu/typescript-doc-gen.git
cd typescript-doc-gen
yarn
yarn gen

去喷竞品

api-hose

react-docgen-typescript

Documentation