@firebase/api-documenter
Advanced tools
Read JSON files from api-extractor, generate documentation pages
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.
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.
FAQs
Read JSON files from api-extractor, generate documentation pages
The npm package @firebase/api-documenter receives a total of 3,789 weekly downloads. As such, @firebase/api-documenter popularity was classified as popular.
We found that @firebase/api-documenter demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.
