Skip to content

Commit 47b3ff5

Browse files
committed
Updated README.
Updated help flag content.
1 parent 83e6b0b commit 47b3ff5

File tree

3 files changed

+30
-2
lines changed

3 files changed

+30
-2
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,30 @@
33
#doxdox
44

55
> HTML and Markdown documentation generator.
6+
7+
A documentation generator that takes output from [dox](https://github.com/visionmedia/dox/) and builds a [Bootstrap](http://getbootstrap.com/) or [Markdown](http://daringfireball.net/projects/markdown/) based documentation file.
8+
9+
##Installation
10+
11+
```bash
12+
$ npm install doxdox -g
13+
```
14+
15+
##Usage
16+
17+
```bash
18+
Usage: doxdox <file> [options]
19+
20+
Options:
21+
22+
-h, --help Display this help message.
23+
-v, --version Display the current installed version.
24+
-t, --title Sets title.
25+
-d, --description Sets description.
26+
-l, --layout Template to render the documentation with.
27+
28+
Available Layouts:
29+
30+
- Bootstrap (default) (http://getbootstrap.com/)
31+
- Markdown (http://daringfireball.net/projects/markdown/)
32+
```

bin/doxdox

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,8 @@ while (args.length) {
6464
process.stdout.write(' -l, --layout\t\tTemplate to render the documentation with.' + '\n');
6565
process.stdout.write('\n');
6666
process.stdout.write(' Available Layouts:' + '\n\n');
67-
process.stdout.write(' - Bootstrap 3\t\t(http://getbootstrap.com/)' + '\n');
68-
process.stdout.write(' - Markdown\t\t(http://daringfireball.net/projects/markdown/)' + '\n');
67+
process.stdout.write(' - Bootstrap (default)\t\t(http://getbootstrap.com/)' + '\n');
68+
process.stdout.write(' - Markdown\t\t\t(http://daringfireball.net/projects/markdown/)' + '\n');
6969
process.stdout.write('\n');
7070
process.kill();
7171
break;

templates/markdown.hbs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
{{registerContext this}}
1010

1111
##{{formatName ctx.string}} {{#if isPrivate}} <small><i>private method<i></small>{{/if}}
12+
1213
{{{description.summary}}}
1314

1415
{{#each tags}}{{#ifCond type "param"}}

0 commit comments

Comments
 (0)