@@ -99,13 +99,17 @@ <h3 id="arguments">Arguments</h3>
99
99
Specifies the location the documentation should be written to.</ li >
100
100
< li > < code > --mode <file|modules></ code > < br >
101
101
Specifies the output mode the project is used to be compiled with.</ li >
102
+ < li > < code > --options</ code > < br >
103
+ Specify a js option file that should be loaded. If not specified TypeDoc will look for 'typedoc.js' in the current directory.</ li >
102
104
< li > < code > --json <path/to/output.json></ code > < br >
103
105
Specifies the location and file name a json file describing the project is written to. When specified no documentation will be generated.</ li >
106
+ < li > < code > --ignoreCompilerErrors</ code > < br >
107
+ Should TypeDoc still generate documentation pages even after the compiler has returned errors?</ li >
104
108
</ ul >
105
109
< h4 id ="source-file-handling "> Source file handling</ h4 >
106
110
< ul >
107
111
< li > < code > --exclude <pattern></ code > < br >
108
- Exclude files by the given pattern when a path is provided as source</ li >
112
+ Exclude files by the given pattern when a path is provided as source. Supports standard minimatch patterns (see < a href =" https://github.com/TypeStrong/typedoc/issues/170 " > #170 </ a > ) </ li >
109
113
< li > < code > --includeDeclarations</ code > < br >
110
114
Turn on parsing of .d.ts declaration files.</ li >
111
115
< li > < code > --externalPattern <pattern></ code > < br >
@@ -131,6 +135,8 @@ <h4 id="theming">Theming</h4>
131
135
< li > < code > --readme <path/to/readme|none></ code > < br >
132
136
Path to the readme file that should be displayed on the index page. Pass < code > none</ code > to disable the index page
133
137
and start the documentation on the globals page.</ li >
138
+ < li > < code > --plugin</ code > < br >
139
+ Specify the npm plugins that should be loaded. Omit to load all installed plugins, set to 'none' to load no plugins.</ li >
134
140
< li > < code > --hideGenerator</ code > < br >
135
141
Do not print the TypeDoc link at the end of the page.</ li >
136
142
< li > < code > --gaID</ code > < br >
@@ -158,7 +164,7 @@ <h4 id="miscellaneous">Miscellaneous</h4>
158
164
< li > < code > --version</ code > < br >
159
165
Display the version number of TypeDoc.</ li >
160
166
< li > < code > --help</ code > < br >
161
- Display a simple cheat sheet .</ li >
167
+ Display all TypeDoc options .</ li >
162
168
</ ul >
163
169
< h3 id ="webpack "> Webpack</ h3 >
164
170
< p > There is a plugin available to run TypeDoc with Webpack created by Microsoft. You can find it on NPM:< br >
@@ -178,8 +184,8 @@ <h2 id="advanced-guides-and-docs">Advanced guides and docs</h2>
178
184
< p > Visit our homepage for advanced guides and an extensive API documentation:< br >
179
185
< a href ="http://typedoc.org "> http://typedoc.org</ a > </ p >
180
186
< h2 id ="contributing "> Contributing</ h2 >
181
- < p > Contributions are welcome and appreciated. You can find TypeDoc on GitHub, feel free to start
182
- an issue or create a pull requests:< br >
187
+ < p > This project is maintained by a community of developers. Contributions are welcome and appreciated.
188
+ You can find TypeDoc on GitHub; feel free to start an issue or create a pull requests:< br >
183
189
< a href ="https://github.com/TypeStrong/typedoc "> https://github.com/TypeStrong/typedoc</ a > </ p >
184
190
< h2 id ="license "> License</ h2 >
185
191
< p > Copyright (c) 2015 < a href ="http://typedoc.org "> Sebastian Lenz</ a > .< br >
0 commit comments