mirror of
https://github.com/hanzoai/firebase-js-sdk.git
synced 2026-09-24 16:59:10 +00:00
FeiyangandGitHub
9fecb4371a
* make toc generation part of the api-documenter * add instruction for generating toc * generate toc only for classes and interfaces * add jssdk flag * update description of the command * change parameter name to --host-path
861 B
861 B
@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.