@firebase/api-documenter
TypeScript icon, indicating that this package has built-in type declarations

0.4.0 • Public • Published

@firebase/api-documenter

It is a fork of API Documenter It reads the *.api.json data files produced by API Extractor, and then generates files in Markdown format suitable for displaying in Firebase Devsite.

Generate toc for Firebase devsite

api-documenter-fire toc -i temp -p "/docs/reference/js/v9"

-i and -p (--host-path) are required parameters. Use -i to specify the folder that contains api.json files. Use -p to specify the g3 path that contains the reference docs.

By default, the command will create toc.yaml in folder /toc. To change the output folder, use the flag -o.

To generate toc for the Firebase JS SDK, also set the flag -j to create the top level firebase toc item.

Readme

Keywords

none

Package Sidebar

Install

npm i @firebase/api-documenter

Weekly Downloads

825

Version

0.4.0

License

Apache-2.0

Unpacked Size

279 kB

Total Files

91

Last publish

Collaborators

  • chholland
  • firebase-ops
  • feiyang.chen
  • google-wombot