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.
- Enter into docs directory
api-documenter markdown
after exec completely, will generate all api markdown file in markdown directory