Skip to content

Commit d60f87b

Browse files
committed
Updated README to include wiki output.
1 parent 4632085 commit d60f87b

File tree

2 files changed

+19
-17
lines changed

2 files changed

+19
-17
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,19 +21,20 @@ $ npm install doxdox -g
2121
2222
Options:
2323
24-
-h, --help Display this help message.
25-
-v, --version Display the current installed version.
26-
-t, --title Sets title.
27-
-d, --description Sets description.
28-
-l, --layout Template to render the documentation with.
29-
-p, --package Sets location of package.json file.
30-
-o, --output File to save documentation to. Defaults to stdout.
24+
-h, --help Display this help message.
25+
-v, --version Display the current installed version.
26+
-t, --title Sets title.
27+
-d, --description Sets description.
28+
-l, --layout Template to render the documentation with.
29+
-p, --package Sets location of package.json file.
30+
-o, --output File to save documentation to. Defaults to stdout.
3131
3232
Available Layouts:
3333
3434
- Bootstrap (default) (http://getbootstrap.com/)
3535
- Markdown (http://daringfireball.net/projects/markdown/)
3636
- Dash (http://kapeli.com/docsets/)
37+
- Wiki (https://help.github.com/articles/about-github-wikis/)
3738
```
3839

3940
## Examples:

bin/doxdox

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -75,18 +75,19 @@ while (args.length) {
7575
process.stdout.write('\n');
7676
process.stdout.write(chalk.blue(' Usage:') + ' doxdox <path> [options]' + '\n\n');
7777
process.stdout.write(' Options:' + '\n\n');
78-
process.stdout.write(chalk.yellow(' -h, --help') + '\t\tDisplay this help message.' + '\n');
79-
process.stdout.write(chalk.yellow(' -v, --version') + '\t\tDisplay the current installed version.' + '\n');
80-
process.stdout.write(chalk.yellow(' -t, --title') + '\t\tSets title.' + '\n');
81-
process.stdout.write(chalk.yellow(' -d, --description') + '\tSets description.' + '\n');
82-
process.stdout.write(chalk.yellow(' -l, --layout') + '\t\tTemplate to render the documentation with.' + '\n');
83-
process.stdout.write(chalk.yellow(' -p, --package') + '\t\tSets location of package.json file.' + '\n');
84-
process.stdout.write(chalk.yellow(' -o, --output') + '\t\tFile to save documentation to. Defaults to stdout.' + '\n');
78+
process.stdout.write(chalk.yellow(' -h, --help') + '\t\t\tDisplay this help message.' + '\n');
79+
process.stdout.write(chalk.yellow(' -v, --version') + '\t\t\tDisplay the current installed version.' + '\n');
80+
process.stdout.write(chalk.yellow(' -t, --title') + '\t\t\tSets title.' + '\n');
81+
process.stdout.write(chalk.yellow(' -d, --description') + '\t\tSets description.' + '\n');
82+
process.stdout.write(chalk.yellow(' -l, --layout') + '\t\t\tTemplate to render the documentation with.' + '\n');
83+
process.stdout.write(chalk.yellow(' -p, --package') + '\t\t\tSets location of package.json file.' + '\n');
84+
process.stdout.write(chalk.yellow(' -o, --output') + '\t\t\tFile to save documentation to. Defaults to stdout.' + '\n');
8585
process.stdout.write('\n');
8686
process.stdout.write(' Available Layouts:' + '\n\n');
87-
process.stdout.write(' - Bootstrap (default)\t (http://getbootstrap.com/)' + '\n');
88-
process.stdout.write(' - Markdown\t\t (http://daringfireball.net/projects/markdown/)' + '\n');
89-
process.stdout.write(' - Dash\t\t (http://kapeli.com/docsets/)' + '\n');
87+
process.stdout.write(' - Bootstrap (default)\t\t(http://getbootstrap.com/)' + '\n');
88+
process.stdout.write(' - Markdown\t\t\t(http://daringfireball.net/projects/markdown/)' + '\n');
89+
process.stdout.write(' - Dash\t\t\t(http://kapeli.com/docsets/)' + '\n');
90+
process.stdout.write(' - Wiki\t\t\t(https://help.github.com/articles/about-github-wikis/)' + '\n');
9091
process.stdout.write('\n');
9192
process.kill();
9293

0 commit comments

Comments
 (0)