Skip to content
Docs site for Angular Material 2
Branch: master
Clone or download
jelbourn and mmalerba Update versions for 7.3.7 (#591)
Also remove the npm `package-lock.json` in favor of `yarn.lock`
Latest commit 7e858ee Apr 5, 2019
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci build: switch to circleci (#574) Jan 18, 2019
e2e Fix karma test running with `ng test` (#31) Dec 13, 2016
src test: component sidenav spec incorrectly creates MediaQueryList object ( Mar 26, 2019
tools Use docs-content from NPM package (#565) Jan 18, 2019
.editorconfig Starter skeleton for Angular Material docs site (#1) Nov 10, 2016
.gitignore Use docs-content from NPM package (#565) Jan 18, 2019
LICENSE docs(readme): update contributing instructions (#541) Oct 26, 2018
angular.json Use docs-content from NPM package (#565) Jan 18, 2019
karma.conf.js Use docs-content from NPM package (#565) Jan 18, 2019
package.json Update versions for 7.3.7 (#591) Apr 4, 2019
tslint.json Update to Angular CLI v6 (#431) Apr 27, 2018
yarn.lock Update versions for 7.3.7 (#591) Apr 4, 2019

Angular Material Docs Site

This is the repository for the Angular Material documentation site.

Versions of this site are also available for


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

Development Setup

  1. Clone Angular Material in the parent directory of this repo
    1. cd ..
    2. git clone
  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/


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
You can’t perform that action at this time.