Skip to content

Commit 272fc51

Browse files
aciccarelloblakeembrey
authored andcommitted
Add missing compiler options to README (#568)
1 parent 3bbf940 commit 272fc51

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,12 +49,16 @@ in order to change the behaviour of TypeDoc.
4949
Specifies the location the documentation should be written to.
5050
* `--mode <file|modules>`<br>
5151
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.
5254
* `--json <path/to/output.json>`<br>
5355
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?
5458

5559
#### Source file handling
5660
* `--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))
5862
* `--includeDeclarations`<br>
5963
Turn on parsing of .d.ts declaration files.
6064
* `--externalPattern <pattern>`<br>
@@ -78,6 +82,8 @@ in order to change the behaviour of TypeDoc.
7882
* `--readme <path/to/readme|none>`<br>
7983
Path to the readme file that should be displayed on the index page. Pass `none` to disable the index page
8084
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.
8187
* `--hideGenerator`<br>
8288
Do not print the TypeDoc link at the end of the page.
8389
* `--gaID`<br>
@@ -102,7 +108,7 @@ in order to change the behaviour of TypeDoc.
102108
* `--version`<br>
103109
Display the version number of TypeDoc.
104110
* `--help`<br>
105-
Display a simple cheat sheet.
111+
Display all TypeDoc options.
106112

107113
### Webpack
108114

@@ -134,8 +140,8 @@ Visit our homepage for advanced guides and an extensive API documentation:<br>
134140

135141
## Contributing
136142

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>
139145
[https://github.com/TypeStrong/typedoc](https://github.com/TypeStrong/typedoc)
140146

141147

0 commit comments

Comments
 (0)