File tree Expand file tree Collapse file tree 1 file changed +9
-0
lines changed
repo-scripts/api-documenter Expand file tree Collapse file tree 1 file changed +9
-0
lines changed Original file line number Diff line number Diff line change 3
3
It is a fork of [ API Documenter] ( https://github.com/microsoft/rushstack/tree/master/apps/api-documenter )
4
4
It reads the * .api.json data files produced by [ API Extractor] ( https://api-extractor.com/ ) ,
5
5
and then generates files in [ Markdown] ( https://en.wikipedia.org/wiki/Markdown ) format suitable for displaying in Firebase Devsite.
6
+
7
+ ## Generate toc for Firebase devsite
8
+ ` api-documenter-fire toc -i temp -p "/docs/reference/js/v9" `
9
+
10
+ ` -i ` and ` -p ` are required parameters.
11
+ Use ` -i ` to specify the folder that contains api.json files.
12
+ Use ` -p ` to specify the g3 path that contains the reference docs.
13
+
14
+ By default, the command will create ` toc.yaml ` in folder ` /toc ` . To change the output folder, use the flag ` -o ` .
You can’t perform that action at this time.
0 commit comments