Package Exports
- @loopback/tsdocs
- @loopback/tsdocs/dist/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@loopback/tsdocs) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
@loopback/tsdocs
This 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
Basic Use
Build api reports and doc models
npm run extract-apidocs -- --reportThe command above will traverse all TypeScript packages in the monorepo and run
api-extractor to generate api reports and doc models into
loopback-next/docs/apidocs:
reports: api reportsreports-temp: temporary api reportsmodels: doc models
Generate api docs as markdown files
npm run document-apidocsIt runs api-documenter to generate markdown files into
loopback-next/docs/site/apidocs.
Update api docs for Jekyll site
npm run update-apidocsIt adds Jekyll metadata to markdown files in loopback-next/docs/site/apidocs
and generates loopback-next/docs/site/apidocs/index.md as the index page.
To run all steps together:
npm run build:tsdocsInstallation
npm install --save @loopback/tsdocsContributions
Tests
Run npm test from the root folder.
Contributors
See all contributors.
License
MIT