Angular Material Docs Site

This is the repository for the Angular Material documentation site.

Versions of this site are also available for

• Beta
• v5
• v6

Contributing

Please open bugs against the Angular Material components, directives, documentation contents, API docs, and demos in the Angular Material repo.

Please only open issues with the documentation site itself (not the content) in this repo. This includes issues like the navigation not working properly, examples or documentation not being presented in an accessible way, issues with rendering or layout of the documentation pages, etc.

Where does the content come from?

The documentation is generated from the following resources

• Guides
• Examples
• Material components, services, and directives
• CDK components, services, and directives

Development Setup

1. Clone Angular Material in the parent directory of this repo
   1. cd ..
   2. git clone git@github.com:angular/material2.git
2. Install Gulp globally: npm i -g gulp
3. Build and copy docs and examples from Angular Material: npm run fetch-local
   • Note that you may need to run this after each time that you run npm i as some of the examples are actually placed in node_modules/@angular/
   • If you see the error Cannot find module '@angular/material-examples', it means that you need to run npm run fetch-local again

Development Server

1. Run npm start for a dev server. Navigate to http://localhost:4200/

Build

Run npm run prod-build to build the project.

Running unit tests

1. Run npm run test to execute the unit tests via Karma.

Running end-to-end tests

Run npm run e2e to execute the end-to-end tests via Protractor. Before running the tests make sure you are serving the app via npm start.

Deployment instructions

> npm install

# Development
> npm run publish-dev

# Production
> npm run publish-prod