Skip to content

Commit bda6d05

Browse files
committed
add instruction for generating toc
1 parent fd9d014 commit bda6d05

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

repo-scripts/api-documenter/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,12 @@
33
It is a fork of [API Documenter](https://github.com/microsoft/rushstack/tree/master/apps/api-documenter)
44
It reads the *.api.json data files produced by [API Extractor](https://api-extractor.com/),
55
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`.

0 commit comments

Comments
 (0)