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
+10-4Lines changed: 10 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -49,12 +49,16 @@ in order to change the behaviour of TypeDoc.
49
49
Specifies the location the documentation should be written to.
50
50
*`--mode <file|modules>`<br>
51
51
Specifies the output mode the project is used to be compiled with.
52
+
*`--options`<br>
53
+
Specify a js option file that should be loaded. If not specified TypeDoc will look for 'typedoc.js' in the current directory.
52
54
*`--json <path/to/output.json>`<br>
53
55
Specifies the location and file name a json file describing the project is written to. When specified no documentation will be generated.
56
+
*`--ignoreCompilerErrors`<br>
57
+
Should TypeDoc still generate documentation pages even after the compiler has returned errors?
54
58
55
59
#### Source file handling
56
60
*`--exclude <pattern>`<br>
57
-
Exclude files by the given pattern when a path is provided as source
61
+
Exclude files by the given pattern when a path is provided as source. Supports standard minimatch patterns (see [#170](https://github.com/TypeStrong/typedoc/issues/170))
58
62
*`--includeDeclarations`<br>
59
63
Turn on parsing of .d.ts declaration files.
60
64
*`--externalPattern <pattern>`<br>
@@ -78,6 +82,8 @@ in order to change the behaviour of TypeDoc.
78
82
*`--readme <path/to/readme|none>`<br>
79
83
Path to the readme file that should be displayed on the index page. Pass `none` to disable the index page
80
84
and start the documentation on the globals page.
85
+
*`--plugin`<br>
86
+
Specify the npm plugins that should be loaded. Omit to load all installed plugins, set to 'none' to load no plugins.
81
87
*`--hideGenerator`<br>
82
88
Do not print the TypeDoc link at the end of the page.
83
89
*`--gaID`<br>
@@ -102,7 +108,7 @@ in order to change the behaviour of TypeDoc.
102
108
*`--version`<br>
103
109
Display the version number of TypeDoc.
104
110
*`--help`<br>
105
-
Display a simple cheat sheet.
111
+
Display all TypeDoc options.
106
112
107
113
### Webpack
108
114
@@ -134,8 +140,8 @@ Visit our homepage for advanced guides and an extensive API documentation:<br>
134
140
135
141
## Contributing
136
142
137
-
Contributions are welcome and appreciated. You can find TypeDoc on GitHub, feel free to start
138
-
an issue or create a pull requests:<br>
143
+
This project is maintained by a community of developers. Contributions are welcome and appreciated.
144
+
You can find TypeDoc on GitHub; feel free to start an issue or create a pull requests:<br>
0 commit comments