
Security News
Meet Socket at Black Hat and DEF CON 2025 in Las Vegas
Meet Socket at Black Hat & DEF CON 2025 for 1:1s, insider security talks at Allegiant Stadium, and a private dinner with top minds in software supply chain security.
@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 6,788 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 0 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
Meet Socket at Black Hat & DEF CON 2025 for 1:1s, insider security talks at Allegiant Stadium, and a private dinner with top minds in software supply chain security.
Security News
CAI is a new open source AI framework that automates penetration testing tasks like scanning and exploitation up to 3,600× faster than humans.
Security News
Deno 2.4 brings back bundling, improves dependency updates and telemetry, and makes the runtime more practical for real-world JavaScript projects.