Skip to content

Add tsconfig argument and description to README #734

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 29, 2018
Merged

Add tsconfig argument and description to README #734

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
de0dd30
Add tsconfig argument and description to README
chrsgrffth Mar 29, 2018
c73d21c
Move tsconfig to the TypeScript Compiler section
chrsgrffth Mar 29, 2018
10fbf21
Remove extra whitespace
chrsgrffth Mar 29, 2018
7eb474f
add tsconfig paramater description
aciccarello Mar 29, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,9 @@ in order to change the behaviour of TypeDoc.
Specify module code generation: "commonjs", "amd", "system" or "umd".
* `--target <ES3, ES5, or ES6>`<br>
Specify ECMAScript target version: "ES3" (default), "ES5" or "ES6"

* `--tsconfig <path/to/tsconfig.json>`<br>
Specify a typescript config file that should be loaded. If not specified TypeDoc will look for 'tsconfig.json' in the current directory.

#### Theming
* `--theme <default|minimal|path/to/theme>`<br>
Specify the path to the theme that should be used.
Expand Down