## 1. Project Overview & Quickstart (mui/material-ui)
## File: README.md
Material UI
[Material UI](https://mui.com/material-ui/) is a comprehensive library of React components that features our independent implementation of Google's [Material Design](https://m2.material.io/design/introduction/) system.
It's trusted by some of the world's greatest product teams because it's been rigorously battle-tested through more than a decade of development by thousands of open-source contributors.
Material UI's core functionality is extended by [MUI X](https://github.com/mui/mui-x), a suite of complex components for advanced use cases.
## Documentation
Get started in the [Material UI documentation](https://mui.com/material-ui/getting-started/).
Older versions
- **[v5.x](https://v5.mui.com/)** ([Upgrading from v5 to v6](https://mui.com/material-ui/migration/upgrade-to-v6/))
- **[v4.x](https://v4.mui.com/)** ([Upgrading from v4 to v5](https://mui.com/material-ui/migration/migration-v4/))
- **[v3.x](https://v3.mui.com/)** ([Upgrading from v3 to v4](https://mui.com/material-ui/migration/migration-v3/))
- **[v0.x](https://v0.mui.com/)** ([Upgrading to v1](https://mui.com/material-ui/migration/migration-v0x/))
**Note:** `@next` points to pre-releases.
Use `@latest` for the latest stable release.
## Sponsors
### Diamond 💎
[](https://www.doit.com/?utm_source=mui.com&utm_medium=referral&utm_content=readme)
Diamond sponsors are those who have pledged $1,500/month or more to MUI.
### Gold 🏆
via [Open Collective](https://opencollective.com/mui-org) or via [Patreon](https://www.patreon.com/oliviertassinari)
[](https://tidelift.com/)
[](https://www.dialmycalls.com/?utm_source=mui.com&utm_medium=referral&utm_content=readme)
[Goread.io](https://goread.io/?utm_source=mui.com&utm_medium=referral&utm_content=readme)
[Buzzoid](https://buzzoid.com/?utm_source=mui.com&utm_medium=referral&utm_content=readme)
[Twicsy](https://twicsy.com/?utm_source=mui.com&utm_medium=referral&utm_content=readme)
[Poprey](https://poprey.com/?utm_source=mui.com&utm_medium=referral&utm_content=readme)
[SocialWick](https://www.socialwick.com/instagram/followers/?utm_source=mui.com&utm_medium=referral&utm_content=readme)
[Follower24](https://www.follower24.de/?utm_source=mui.com&utm_medium=referral&utm_content=readme)
[Views4You](https://views4you.com/?utm_source=mui.com&utm_medium=referral&utm_content=readme)
Gold sponsors are those who have pledged $500/month or more to MUI.
### More backers
See the full list of [our backers](https://mui.com/material-ui/discover-more/backers/).
## Questions
For how-to questions that don't involve making changes to the code base, please use [Stack Overflow](https://stackoverflow.com/questions/) instead of GitHub issues.
## Examples
Our documentation features [a collection of example projects](https://github.com/mui/material-ui/tree/master/examples).
## Premium templates
You can find complete templates and themes in the [MUI Store](https://mui.com/store/?utm_source=docs&utm_medium=referral&utm_campaign=readme-store).
## Contributing
Read the [contributing guide](/CONTRIBUTING.md) to learn about our development process, how to propose bug fixes and improvements, and how to build and test your changes.
Contributing is about more than just issues and pull requests!
There are many other ways to [support Material UI](https://mui.com/material-ui/getting-started/faq/#mui-is-an-awesome-organization-how-can-i-support-it) beyond contributing to the code base.
## Changelog
The [changelog](https://github.com/mui/material-ui/releases) is regularly updated to reflect what's changed in each new release.
## Roadmap
Future plans and high-priority features and enhancements can be found in the [roadmap](https://mui.com/material-ui/discover-more/roadmap/).
## License
This project is licensed under the terms of the [MIT license](/LICENSE).
## Security
For details on supported versions and contact information for reporting security issues, please refer to the [security policy](https://github.com/mui/material-ui/security/policy).
## Sponsoring services
These great services sponsor MUI's core infrastructure:
[GitHub](https://github.com/) lets us host the Git repository and coordinate contributions.
[Netlify](https://www.netlify.com/) lets us distribute the documentation.
[CodeCov](https://about.codecov.io/) lets us monitor test coverage.
---
## File: docs/README.md
# Docs
This is the website of the company MUI and the documentation for Material UI.
To start the docs site in development mode, from the project root, run:
```bash
pnpm docs:dev
```
If you do not have pnpm installed, select your OS and follow the instructions on the [pnpm website](https://pnpm.io/installation).
Package managers other than pnpm (like npm or Yarn) are not supported and will not work.
## How can I add a new demo to the documentation?
[You can follow this guide](../CONTRIBUTING.md)
on how to get started contributing to MUI.
## How do I help to improve the translations?
Please visit https://crowdin.com/project/material-ui-docs where you will be able to select a language and edit the translations.
Please don't submit pull requests directly.
## 2. Official Technical Reference & Guides (mui/material-ui-docs)
## File: README.md
Material UI
[Material UI](https://mui.com/material-ui/) is a comprehensive library of React components that features our independent implementation of Google's [Material Design](https://m2.material.io/design/introduction/) system.
It's trusted by some of the world's greatest product teams because it's been rigorously battle-tested through more than a decade of development by thousands of open-source contributors.
Material UI's core functionality is extended by [MUI X](https://github.com/mui/mui-x), a suite of complex components for advanced use cases.
## Documentation
Get started in the [Material UI documentation](https://mui.com/material-ui/getting-started/).
Older versions
- **[v5.x](https://v5.mui.com/)** ([Upgrading from v5 to v6](https://mui.com/material-ui/migration/upgrade-to-v6/))
- **[v4.x](https://v4.mui.com/)** ([Upgrading from v4 to v5](https://mui.com/material-ui/migration/migration-v4/))
- **[v3.x](https://v3.mui.com/)** ([Upgrading from v3 to v4](https://mui.com/material-ui/migration/migration-v3/))
- **[v0.x](https://v0.mui.com/)** ([Upgrading to v1](https://mui.com/material-ui/migration/migration-v0x/))
**Note:** `@next` points to pre-releases.
Use `@latest` for the latest stable release.
## Sponsors
### Diamond 💎
[](https://www.doit.com/?utm_source=mui.com&utm_medium=referral&utm_content=readme)
Diamond sponsors are those who have pledged $1,500/month or more to MUI.
### Gold 🏆
via [Open Collective](https://opencollective.com/mui-org) or via [Patreon](https://www.patreon.com/oliviertassinari)
[](https://tidelift.com/)
[](https://www.dialmycalls.com/?utm_source=mui.com&utm_medium=referral&utm_content=readme)
[Goread.io](https://goread.io/?utm_source=mui.com&utm_medium=referral&utm_content=readme)
[Buzzoid](https://buzzoid.com/?utm_source=mui.com&utm_medium=referral&utm_content=readme)
[Twicsy](https://twicsy.com/?utm_source=mui.com&utm_medium=referral&utm_content=readme)
[Poprey](https://poprey.com/?utm_source=mui.com&utm_medium=referral&utm_content=readme)
[SocialWick](https://www.socialwick.com/instagram/followers/?utm_source=mui.com&utm_medium=referral&utm_content=readme)
[Follower24](https://www.follower24.de/?utm_source=mui.com&utm_medium=referral&utm_content=readme)
[Views4You](https://views4you.com/?utm_source=mui.com&utm_medium=referral&utm_content=readme)
Gold sponsors are those who have pledged $500/month or more to MUI.
### More backers
See the full list of [our backers](https://mui.com/material-ui/discover-more/backers/).
## Questions
For how-to questions that don't involve making changes to the code base, please use [Stack Overflow](https://stackoverflow.com/questions/) instead of GitHub issues.
## Examples
Our documentation features [a collection of example projects](https://github.com/mui/material-ui/tree/master/examples).
## Premium templates
You can find complete templates and themes in the [MUI Store](https://mui.com/store/?utm_source=docs&utm_medium=referral&utm_campaign=readme-store).
## Contributing
Read the [contributing guide](/CONTRIBUTING.md) to learn about our development process, how to propose bug fixes and improvements, and how to build and test your changes.
Contributing is about more than just issues and pull requests!
There are many other ways to [support Material UI](https://mui.com/material-ui/getting-started/faq/#mui-is-an-awesome-organization-how-can-i-support-it) beyond contributing to the code base.
## Changelog
The [changelog](https://github.com/mui/material-ui/releases) is regularly updated to reflect what's changed in each new release.
## Roadmap
Future plans and high-priority features and enhancements can be found in the [roadmap](https://mui.com/material-ui/discover-more/roadmap/).
## License
This project is licensed under the terms of the [MIT license](/LICENSE).
## Security
For details on supported versions and contact information for reporting security issues, please refer to the [security policy](https://github.com/mui/material-ui/security/policy).
## Sponsoring services
These great services sponsor MUI's core infrastructure:
[GitHub](https://github.com/) lets us host the Git repository and coordinate contributions.
[Netlify](https://www.netlify.com/) lets us distribute the documentation.
[CodeCov](https://about.codecov.io/) lets us monitor test coverage.
---
## File: docs/README.md
# Docs
This is the website of the company MUI and the documentation for Material UI.
To start the docs site in development mode, from the project root, run:
```bash
pnpm docs:dev
```
If you do not have pnpm installed, select your OS and follow the instructions on the [pnpm website](https://pnpm.io/installation).
Package managers other than pnpm (like npm or Yarn) are not supported and will not work.
## How can I add a new demo to the documentation?
[You can follow this guide](../CONTRIBUTING.md)
on how to get started contributing to MUI.
## How do I help to improve the translations?
Please visit https://crowdin.com/project/material-ui-docs where you will be able to select a language and edit the translations.
Please don't submit pull requests directly.