@loopback/tsdocs

A package to generate api docs using Microsoft api-extractor and api-documenter

Usage no npm install needed!

<script type="module">
  import loopbackTsdocs from 'https://cdn.skypack.dev/@loopback/tsdocs';
</script>

README

@loopback/tsdocs

This module provides API docs generation for @loopback/* packages.

It's built on top of https://api-extractor.com/:

Basic Use

Build api reports and doc models

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 into loopback-next/docs/apidocs:

  • reports: api reports
  • reports-temp: temporary api reports
  • models: doc models

Generate api docs as markdown files

npm run document-apidocs

It runs api-documenter to generate markdown files into loopback-next/docs/site/apidocs.

Update api docs for Jekyll site

npm run update-apidocs

It 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:tsdocs

Installation

npm install --save @loopback/tsdocs

Contributions

Tests

Run npm test from the root folder.

Contributors

See all contributors.

License

MIT