快速上手 ​

注意这里默认已经配置好一个ts项目，这里我会使用tsc用于测试

1. 安装依赖

npm install  @microsoft/api-extractor -D

npm install  @microsoft/api-extractor -D

2. 创建模板配置文件 以下命令将创建一个模板文件，其中显示所有设置及其默认值：api-extractor.json

 npx api-extractor init

 npx api-extractor init

然后会多一个api-extractor.json, 这里由于给的json携带注释所以报错了。

如果觉得红色影响阅读 可以在vscode上方搜索 json with Comments,找到检索项后点击红色就消失了

这里需要将 mainEntryPointFilePath 改为自己的入口dts

将 tsconfigFilePath 设置为tsconfig.json

创建一个ect文件夹 3. 执行打包命令

   npx api-extractor run --local --verbose

   npx api-extractor run --local --verbose

这样就可以使用这个生成的json文件去生成api文档了，这篇不会教学怎么使用这个json生成md文件