File tree 2 files changed +4
-4
lines changed
repo-scripts/api-documenter
2 files changed +4
-4
lines changed Original file line number Diff line number Diff line change @@ -7,7 +7,7 @@ and then generates files in [Markdown](https://en.wikipedia.org/wiki/Markdown) f
7
7
## Generate toc for Firebase devsite
8
8
` api-documenter-fire toc -i temp -p "/docs/reference/js/v9" `
9
9
10
- ` -i ` and ` -p ` are required parameters.
10
+ ` -i ` and ` -p ` ( ` --host-path ` ) are required parameters.
11
11
Use ` -i ` to specify the folder that contains api.json files.
12
12
Use ` -p ` to specify the g3 path that contains the reference docs.
13
13
Original file line number Diff line number Diff line change @@ -38,10 +38,10 @@ export class TocAction extends BaseAction {
38
38
super . onDefineParameters ( ) ;
39
39
40
40
this . _g3PathParameter = this . defineStringParameter ( {
41
- parameterLongName : '--g3 -path' ,
41
+ parameterLongName : '--host -path' ,
42
42
parameterShortName : '-p' ,
43
- argumentName : 'G3PREFIX ' ,
44
- description : `Specifies the path where the reference docs will be written to in g3 .
43
+ argumentName : 'HOSTPATH ' ,
44
+ description : `Specifies the path where the reference docs resides (e.g. g3) .
45
45
Used to generate paths in the toc`
46
46
} ) ;
47
47
You can’t perform that action at this time.
0 commit comments