@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 5,060 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
The EU Cyber Resilience Act is prompting compliance requests that open source maintainers may not be obligated or equipped to handle.
Security News
Crates.io adds Trusted Publishing support, enabling secure GitHub Actions-based crate releases without long-lived API tokens.
Research
/Security News
Undocumented protestware found in 28 npm packages disrupts UI for Russian-language users visiting Russian and Belarusian domains.
