You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+27Lines changed: 27 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -3,3 +3,30 @@
3
3
#doxdox
4
4
5
5
> 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.
0 commit comments