Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sebastian-lenz committed Jan 25, 2015
1 parent d93bf24 commit 19fdf2f
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,21 @@ generator. So in order to create a documentation for an entire project you simpl
$ typedoc --out path/to/documentation/ path/to/typescript/project/
```

### Important note

Starting with version 0.2, TypeDoc no longer can predict whether files should be treated as modules
or whether the project should be compiled into one big namespace. You must specify the `mode` argument
in order to change the behaviour of TypeDoc.


### Arguments

* `--out <path/to/documentation/>`<br>
Specifies the location the documentation should be written to.
* `--mode <file|modules>`<br>
Specifies the output mode the project is used to be compiled with.
* `--json <path/to/output.json>`<br>
Specifies the location and file name a json file describing the project is written to. When specified no documentation will be generated.

#### Source file handling
* `--exclude <pattern>`<br>
Expand Down

0 comments on commit 19fdf2f

Please sign in to comment.