File tree Expand file tree Collapse file tree 1 file changed +11
-0
lines changed
Expand file tree Collapse file tree 1 file changed +11
-0
lines changed Original file line number Diff line number Diff line change @@ -45,10 +45,21 @@ generator. So in order to create a documentation for an entire project you simpl
4545$ typedoc --out path/to/documentation/ path/to/typescript/project/
4646```
4747
48+ ### Important note
49+
50+ Starting with version 0.2, TypeDoc no longer can predict whether files should be treated as modules
51+ or whether the project should be compiled into one big namespace. You must specify the ` mode ` argument
52+ in order to change the behaviour of TypeDoc.
53+
54+
4855### Arguments
4956
5057* ` --out <path/to/documentation/> ` <br >
5158 Specifies the location the documentation should be written to.
59+ * ` --mode <file|modules> ` <br >
60+ Specifies the output mode the project is used to be compiled with.
61+ * ` --json <path/to/output.json> ` <br >
62+ Specifies the location and file name a json file describing the project is written to. When specified no documentation will be generated.
5263
5364#### Source file handling
5465* ` --exclude <pattern> ` <br >
You can’t perform that action at this time.
0 commit comments