🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more
Socket
Book a DemoInstallSign in
Socket

@firebase/api-documenter

Package Overview
Dependencies
Maintainers
0
Versions
1198
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@firebase/api-documenter

Read JSON files from api-extractor, generate documentation pages

0.5.0
latest
Source
npm
Version published
Weekly downloads
8.6K
-46.11%
Maintainers
0
Weekly downloads
 
Created
Source

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

FAQs

Package last updated on 27 Feb 2025

Did you know?

Socket

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.

Install

Related posts