”;
This chapter explains the syntax, arguments and options of ng doc command along with an example.
Syntax
The syntax for ng doc command is as follows −
ng doc <keyword> [options] ng d <keyword> [options]
ng doc command opens the official Angular documentation in a browser, and searches for a given keyword. Options are optional parameters.
Arguments
The arguments for ng doc command is as follows −
| Sr.No. | Argument & Syntax | Description |
|---|---|---|
| 1 | <keyword> | The keyword to search for, as provided in the search bar in angular.io. |
Options
Options are optional parameters.
| Sr.No. | Option & Syntax | Description |
|---|---|---|
| 1 | –help=true|false|json|JSON |
Shows a help message for this command in the console.
Default: false
|
First move to an angular project updated using ng build command.This chapter is available at https://www.tutorialspoint.com/angular_cli/angular_cli_ng_build.htm.
Now run the doc command.
Example
An example for ng doc command is given below −
>Node>TutorialsPoint> ng doc build
Now a browser window will open and search the relevant keyword.
”;