Angular Components Docs Site

This is the repository for the Angular Components documentation site.

Versions of this site are also available for

• v5
• v6
• v7
• v8
• v9
• v10
• v11
• v12

Contributing

Please open bugs against the Angular Material and CDK components, directives, documentation contents, API docs, and demos in the Angular Components 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 guides, examples, and docs content repo angular/material2-docs-content contains the documentation content and examples. They are generated from:

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

Development Setup

1. Make sure you have NodeJS LTS installed
2. Make sure you have Yarn installed
3. Install the project's dependencies
   • yarn install
4. Update to the latest version of the docs-content and examples
   • yarn build:content

Development Server

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

Build

Run yarn prod-build to build the project.

Running unit tests

1. Run yarn test to execute the unit tests via Karma.

Running end-to-end tests

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

Deployment instructions

> yarn install
> yarn upgrade @angular/components-examples

# Development
> yarn publish-dev

# Production
> yarn publish-prod