Skip to content

Commit 74339a1

Browse files
authored
docs: fix up getting started guide (#23359)
Fixes some weird formatting and a few minor content issues in the "Getting started" guide.
1 parent bcb16ab commit 74339a1

File tree

1 file changed

+25
-13
lines changed

1 file changed

+25
-13
lines changed

guides/getting-started.md

Lines changed: 25 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,30 @@
11
# Getting Started with Angular Material
22

3-
This guide explains how to set up your Angular project to begin using Angular Material. It includes information on prerequisites, installing Angular Material, and optionally displaying a sample material component in your application to verify your setup.
3+
This guide explains how to set up your Angular project to begin using Angular Material. It includes
4+
information on prerequisites, installing Angular Material, and optionally displaying a sample
5+
Material component in your application to verify your setup.
46

57
*Angular Resources*
68

7-
If you are new to Angular or getting started with a new Angular application, see [Angular's full Getting Started Guide](https://angular.io/start) and [Setting up your environment](https://angular.io/guide/setup-local).
9+
If you are new to Angular or getting started with a new Angular application, see
10+
[Angular's full Getting Started Guide](https://angular.io/start) and
11+
[Setting up your environment](https://angular.io/guide/setup-local).
812

913
For existing applications, follow the steps below to begin using Angular Material.
1014

1115
## Install Angular Material
1216

13-
Use the Angular CLI's installation [schematic](https://material.angular.io/guide/schematics) to set up your Angular Material project by running the following command:
17+
Use the Angular CLI's installation [schematic](https://material.angular.io/guide/schematics) to set
18+
up your Angular Material project by running the following command:
1419

1520
```bash
1621
ng add @angular/material
1722
```
1823

19-
The `ng add` command will install Angular Material, the [Component Dev Kit (CDK)](https://material.angular.io/cdk/categories), [Angular Animations](https://angular.io/guide/animations) and ask you the following questions to determine which features to include:
24+
The `ng add` command will install Angular Material, the
25+
[Component Dev Kit (CDK)](https://material.angular.io/cdk/categories),
26+
[Angular Animations](https://angular.io/guide/animations) and ask you the following questions to
27+
determine which features to include:
2028

2129
1. Choose a prebuilt theme name, or "custom" for a custom theme:
2230

@@ -30,7 +38,7 @@ The `ng add` command will install Angular Material, the [Component Dev Kit (CDK)
3038

3139
Importing the [`BrowserAnimationsModule`](https://angular.io/api/platform-browser/animations/BrowserAnimationsModule) into your application enables Angular's [animation system](https://angular.io/guide/animations). Declining this will disable most of Angular Material's animations.
3240

33-
The `ng add` command will additionally perform the following configurations:
41+
The `ng add` command will additionally perform the following actions:
3442

3543
* Add project dependencies to `package.json`
3644
* Add the Roboto font to your `index.html`
@@ -47,16 +55,18 @@ You're done! Angular Material is now configured to be used in your application.
4755

4856
Let's display a slider component in your app and verify that everything works.
4957

50-
You need to import the `MatSliderModule` that you want to display by adding the following lines to your app.module.ts file.
58+
You need to import the `MatSliderModule` that you want to display by adding the following lines to
59+
your `app.module.ts` file.
5160

5261
```ts
5362
import { MatSliderModule } from '@angular/material/slider';
54-
55-
@NgModule ({....
56-
imports: [...,
57-
MatSliderModule,
58-
]
63+
64+
@NgModule ({
65+
imports: [
66+
MatSliderModule,
67+
]
5968
})
69+
class AppModule {}
6070
```
6171

6272
Add the `<mat-slider>` tag to the `app.component.html` like so:
@@ -73,6 +83,8 @@ ng serve
7383

7484
Then point your browser to [http://localhost:4200](http://localhost:4200)
7585

76-
You should see the material slider component on the page.
86+
You should see the Material slider component on the page.
7787

78-
In addition to the installation schematic, Angular Material comes with [several schematics](https://material.angular.io/guide/schematics) (like nav, table, address-form, etc.) that can be used to easily generate pre-built components in your application.
88+
In addition to the installation schematic, Angular Material comes with
89+
[several other schematics](https://material.angular.io/guide/schematics) (like nav, table,
90+
address-form, etc.) that can be used to easily generate pre-built components in your application.

0 commit comments

Comments
 (0)