Generate API docs by powerful ts-doc

原创已于 2024-09-01 23:50:10 修改 · 435 阅读

8 ·

CC 4.0 BY-SA版权

文章标签：

#前端 #typescript

于 2023-12-17 10:36:38 首次发布

前端专栏收录该内容

8 篇文章

订阅专栏

本文详细介绍了如何通过PowerTS-LD和ApiExtractor工具生成API文档，步骤包括将`<project-name>.api.json`文件从临时目录移动到输入目录，以及在项目根目录下初始化并运行ApiExtractor和ApiDocumenter来生成APIJSON和Markdown文件。

Generate API docs by powerful ts-doc

require follows-as directory structure by api-documenter

./docs
  ├── input               # move the `<project-name>.api.json` from temp dir to input dir
  └── markdown            # generate api markdown file by `api-documenter markdown`
  └── temp                # generate by `api-extractor run --local --verbose`
|-- api-extractor.json    # generate by `api-extractor init`

Install globally api-extractor api-documenter

npm install -g @microsoft/api-extractor @microsoft/api-documenter

Generate markdown steps

Init api-extractor

enter into root directory of project

api-extractor init

after exec completely, will generate api-extractor.json file

Generate API JSON file for api markdown

api-extractor run --local --verbose

after exec completely, will generate temporary directory named temp which includes [packageName]-api.json、[packageName]-api.md、[packageName]-api.pdf files. Then, copy [packageName]-api.json to docs/input directory.