File tree Expand file tree Collapse file tree 2 files changed +6
-6
lines changed Expand file tree Collapse file tree 2 files changed +6
-6
lines changed Original file line number Diff line number Diff line change @@ -15,17 +15,17 @@ $ npm install doxdox -g
15
15
##Usage
16
16
17
17
``` bash
18
- Usage: doxdox < file > [options]
18
+ Usage: doxdox < path > [options]
19
19
20
20
Options:
21
21
22
22
-h, --help Display this help message.
23
23
-v, --version Display the current installed version.
24
24
-t, --title Sets title.
25
25
-d, --description Sets description.
26
- -p, --package Sets location of package.json file.
27
26
-l, --layout Template to render the documentation with.
28
- -o, --output File to save documentation to. Default to stdout.
27
+ -p, --package Sets location of package.json file.
28
+ -o, --output File to save documentation to. Defaults to stdout.
29
29
30
30
Available Layouts:
31
31
Original file line number Diff line number Diff line change @@ -60,15 +60,15 @@ while (args.length) {
60
60
61
61
default :
62
62
process . stdout . write ( '\n' ) ;
63
- process . stdout . write ( chalk . blue ( ' Usage:' ) + ' doxdox <file > [options]' + '\n\n' ) ;
63
+ process . stdout . write ( chalk . blue ( ' Usage:' ) + ' doxdox <path > [options]' + '\n\n' ) ;
64
64
process . stdout . write ( ' Options:' + '\n\n' ) ;
65
65
process . stdout . write ( chalk . yellow ( ' -h, --help' ) + '\t\tDisplay this help message.' + '\n' ) ;
66
66
process . stdout . write ( chalk . yellow ( ' -v, --version' ) + '\t\tDisplay the current installed version.' + '\n' ) ;
67
67
process . stdout . write ( chalk . yellow ( ' -t, --title' ) + '\t\tSets title.' + '\n' ) ;
68
68
process . stdout . write ( chalk . yellow ( ' -d, --description' ) + '\tSets description.' + '\n' ) ;
69
- process . stdout . write ( chalk . yellow ( ' -p, --package' ) + '\tSets location of package.json file.' + '\n' ) ;
70
69
process . stdout . write ( chalk . yellow ( ' -l, --layout' ) + '\t\tTemplate to render the documentation with.' + '\n' ) ;
71
- process . stdout . write ( chalk . yellow ( ' -o, --output' ) + '\t\tFile to save documentation to. Default to stdout.' + '\n' ) ;
70
+ process . stdout . write ( chalk . yellow ( ' -p, --package' ) + '\tSets location of package.json file.' + '\n' ) ;
71
+ process . stdout . write ( chalk . yellow ( ' -o, --output' ) + '\t\tFile to save documentation to. Defaults to stdout.' + '\n' ) ;
72
72
process . stdout . write ( '\n' ) ;
73
73
process . stdout . write ( ' Available Layouts:' + '\n\n' ) ;
74
74
process . stdout . write ( ' - Bootstrap (default)\t (http://getbootstrap.com/)' + '\n' ) ;
You can’t perform that action at this time.
0 commit comments