A package to generate api docs using Microsoft api-extractor and api-documenter
npm install @loopback/tsdocsThis module provides API docs generation
for @loopback/* packages.
It's built on top of https://api-extractor.com/:
- https://github.com/Microsoft/web-build-tools/tree/master/apps/api-extractor
- https://github.com/Microsoft/web-build-tools/tree/master/apps/api-documenter
``sh`
npm run extract-apidocs -- --report
The command above will traverse all TypeScript packages in the monorepo and run
api-extractor to generate api reports and doc models intoloopback-next/docs/apidocs:
- reports: api reportsreports-temp
- : temporary api reportsmodels
- : doc models
`sh`
npm run document-apidocs
It runs api-documenter to generate markdown files intoloopback-next/docs/site/apidocs.
`sh`
npm run update-apidocs
It adds Jekyll metadata to markdown files in loopback-next/docs/site/apidocs
and generates as the index page.
To run all steps together:
`sh`
npm run build:tsdocs
`sh`
npm install --save @loopback/tsdocs
Run npm test` from the root folder.
See
all contributors.
MIT