Skip to content

Files

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Latest commit

43f8605 · May 21, 2021

History

History
16 lines (11 loc) · 845 Bytes
·

File metadata and controls

16 lines (11 loc) · 845 Bytes
·

@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 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.