Skip to content

Commit

Permalink
more
Browse files Browse the repository at this point in the history
  • Loading branch information
@oliviertassinari
oliviertassinari committed Sep 7, 2024
1 parent 4792117 commit a58f16b
Show file tree
Hide file tree
Showing 38 changed files with 75 additions and 75 deletions.
52 changes: 26 additions & 26 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
<!-- markdownlint-disable-next-line -->
<p align="center">
<a href="https://mui.com/core/" rel="noopener" target="_blank"><img width="150" height="133" src="https://mui.com/static/logo.svg" alt="MUI Core logo"></a>
<a href="https://v5.mui.com/core/" rel="noopener" target="_blank"><img width="150" height="133" src="https://v5.mui.com/static/logo.svg" alt="MUI Core logo"></a>
</p>

<h1 align="center">MUI Core</h1>

**MUI Core** contains foundational React UI component libraries for shipping new features faster:

- [Material UI](https://mui.com/material-ui/) is a comprehensive library of components that features our implementation of Google's [Material Design](https://m2.material.io/design/introduction/) system.
- [Material UI](https://v5.mui.com/material-ui/) is a comprehensive library of components that features our implementation of Google's [Material Design](https://m2.material.io/design/introduction/) system.

Check warning on line 10 in README.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.We] Try to avoid using first-person plural like 'our'.

Raw Output:
{"message": "[Google.We] Try to avoid using first-person plural like 'our'.", "location": {"path": "README.md", "range": {"start": {"line": 10, "column": 105}}}, "severity": "WARNING"}

- [Joy UI](https://mui.com/joy-ui/getting-started/) is a library of beautifully designed React UI components built to spark joy.
- [Joy UI](https://v5.mui.com/joy-ui/getting-started/) is a library of beautifully designed React UI components built to spark joy.

- [Base UI](https://mui.com/base-ui/) is a library of unstyled React UI components and hooks. With Base UI, you gain complete control over your app's CSS and accessibility features.
- [Base UI](https://v5.mui.com/base-ui/) is a library of unstyled React UI components and hooks. With Base UI, you gain complete control over your app's CSS and accessibility features.

- [MUI System](https://mui.com/system/getting-started/) is a collection of CSS utilities to help you rapidly lay out custom designs.
- [MUI System](https://v5.mui.com/system/getting-started/) is a collection of CSS utilities to help you rapidly lay out custom designs.

<div align="center">

Expand All @@ -35,14 +35,14 @@

### Material UI

Visit [https://mui.com/material-ui/](https://mui.com/material-ui/) to view the full documentation.
Visit [https://v5.mui.com/material-ui/](https://v5.mui.com/material-ui/) to view the full documentation.

<details>
<summary>Older versions</summary>

- **[v4.x](https://v4.mui.com/)** ([Migration from v4 to v5](https://mui.com/material-ui/migration/migration-v4/))
- **[v3.x](https://v3.mui.com/)** ([Migration from v3 to v4](https://mui.com/material-ui/migration/migration-v3/))
- **[v0.x](https://v0.mui.com/)** ([Migration to v1](https://mui.com/material-ui/migration/migration-v0x/))
- **[v4.x](https://v4.mui.com/)** ([Migration from v4 to v5](https://v5.mui.com/material-ui/migration/migration-v4/))
- **[v3.x](https://v3.mui.com/)** ([Migration from v3 to v4](https://v5.mui.com/material-ui/migration/migration-v3/))
- **[v0.x](https://v0.mui.com/)** ([Migration to v1](https://v5.mui.com/material-ui/migration/migration-v0x/))

</details>

Expand All @@ -51,30 +51,30 @@ Use `@latest` for the latest stable release.

### Joy UI

Visit [https://mui.com/joy-ui/getting-started/](https://mui.com/joy-ui/getting-started/) to view the full documentation.
Visit [https://v5.mui.com/joy-ui/getting-started/](https://v5.mui.com/joy-ui/getting-started/) to view the full documentation.

**Note**: Joy UI is still in beta.
We are adding new components regularly and you're welcome to contribute!

### Base UI

Visit [https://mui.com/base-ui/](https://mui.com/base-ui/) to view the full documentation.
Visit [https://v5.mui.com/base-ui/](https://v5.mui.com/base-ui/) to view the full documentation.

**Note**: Base UI is still in beta.
We are adding new components regularly and you're welcome to contribute!

### MUI System

Visit [https://mui.com/system/getting-started/](https://mui.com/system/getting-started/) to view the full documentation.
Visit [https://v5.mui.com/system/getting-started/](https://v5.mui.com/system/getting-started/) to view the full documentation.

## Sponsors

### Diamond 💎

<p>
<a href="https://octopus.com/?utm_source=MUI&utm_medium=referral&utm_content=readme" rel="noopener sponsored" target="_blank"><img height="128" width="128" src="https://mui.com/static/sponsors/octopus-square.svg" alt="octopus" title="Repeatable, reliable deployments" loading="lazy" /></a>
<a href="https://www.doit.com/?utm_source=MUI&utm_medium=referral&utm_content=readme" rel="noopener sponsored" target="_blank"><img height="128" width="128" src="https://mui.com/static/sponsors/doit-square.svg" alt="doit" title="Management Platform for Google Cloud and AWS" loading="lazy" /></a>
<a href="https://www.marblism.com/?utm_source=mui" rel="noopener sponsored" target="_blank"><img height="128" width="128" src="https://mui.com/static/sponsors/marblism-square.svg" alt="marblism" title="AI web app generation" loading="lazy" /></a>
<a href="https://octopus.com/?utm_source=MUI&utm_medium=referral&utm_content=readme" rel="noopener sponsored" target="_blank"><img height="128" width="128" src="https://v5.mui.com/static/sponsors/octopus-square.svg" alt="octopus" title="Repeatable, reliable deployments" loading="lazy" /></a>
<a href="https://www.doit.com/?utm_source=MUI&utm_medium=referral&utm_content=readme" rel="noopener sponsored" target="_blank"><img height="128" width="128" src="https://v5.mui.com/static/sponsors/doit-square.svg" alt="doit" title="Management Platform for Google Cloud and AWS" loading="lazy" /></a>
<a href="https://www.marblism.com/?utm_source=mui" rel="noopener sponsored" target="_blank"><img height="128" width="128" src="https://v5.mui.com/static/sponsors/marblism-square.svg" alt="marblism" title="AI web app generation" loading="lazy" /></a>
</p>

Diamond sponsors are those who have pledged \$1,500/month or more to MUI.
Expand All @@ -89,7 +89,7 @@ via [Open Collective](https://opencollective.com/mui-org) or via [Patreon](http
<a href="https://icons8.com?utm_source=MUI&utm_medium=referral&utm_content=readme" rel="noopener sponsored" target="_blank"><img height="96" width="96" src="https://images.opencollective.com/icons8/7fa1641/logo/288.png" alt="Icons8" title="Icons8: API for icons, photos, illustrations, and music." loading="lazy"></a>
<a href="https://rxdb.info/?utm_source=sponsor&utm_medium=opencollective&utm_campaign=opencollective-mui" rel="noopener sponsored" target="_blank"><img height="96" width="96" src="https://rxdb.info/files/logo/logo_text.svg" alt="RxDB" title="RxDB: Local-first JavaScript database." loading="lazy" /></a>
<a href="https://www.text-em-all.com/?utm_source=MUI&utm_medium=referral&utm_content=readme" rel="noopener sponsored" target="_blank"><img src="https://avatars.githubusercontent.com/u/1262264?s=288" alt="text-em-all.com" title="Text-em-all: Mass text messaging and automated calling." height="96" width="96" loading="lazy"></a>
<a href="https://megafamous.com/?utm_source=MUI&utm_medium=referral&utm_content=readme" rel="noopener sponsored" target="_blank"><img height="96" width="96" src="https://mui.com/static/sponsors/megafamous.png" alt="megafamous.com" title="MegaFamous: Buy Instagram followers and likes." loading="lazy" /></a>
<a href="https://megafamous.com/?utm_source=MUI&utm_medium=referral&utm_content=readme" rel="noopener sponsored" target="_blank"><img height="96" width="96" src="https://v5.mui.com/static/sponsors/megafamous.png" alt="megafamous.com" title="MegaFamous: Buy Instagram followers and likes." loading="lazy" /></a>
<a href="https://www.dialmycalls.com/?utm_source=MUI&utm_medium=referral&utm_content=readme" rel="noopener sponsored" target="_blank"><img height="96" width="96" src="https://images.opencollective.com/dialmycalls/f5ae9ab/avatar/288.png" alt="dialmycalls.com" title="DialMyCalls: Send text messages, calls, and emails." loading="lazy" /></a>
<a href="https://goread.io/?utm_source=MUI&utm_medium=referral&utm_content=readme" rel="noopener sponsored" target="_blank"><img height="96" width="96" src="https://images.opencollective.com/goread_io/eb6337d/logo/288.png" alt="goread.io" title="Goread.io: Instagram followers, likes, views, and comments." loading="lazy" /></a>
</p>
Expand Down Expand Up @@ -117,7 +117,7 @@ You can find complete templates and themes in the [MUI Store](https://mui.com/s
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-awesome-how-can-i-support-the-project) beyond contributing to the code base.
There are many other ways to [support Material UI](https://v5.mui.com/material-ui/getting-started/faq/#mui-is-awesome-how-can-i-support-the-project) beyond contributing to the code base.

## Changelog

Expand All @@ -142,9 +142,9 @@ These great services sponsor MUI's core infrastructure:

<div>
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://mui.com/static/readme/github-darkmode.svg">
<source media="(prefers-color-scheme: light)" srcset="https://mui.com/static/readme/github-lightmode.svg">
<img alt="GitHub logo" src="https://mui.com/static/readme/github-lightmode.svg" width="80" height="43">
<source media="(prefers-color-scheme: dark)" srcset="https://v5.mui.com/static/readme/github-darkmode.svg">
<source media="(prefers-color-scheme: light)" srcset="https://v5.mui.com/static/readme/github-lightmode.svg">
<img alt="GitHub logo" src="https://v5.mui.com/static/readme/github-lightmode.svg" width="80" height="43">
</picture>

[GitHub](https://github.com/) lets us host the Git repository and coordinate contributions.
Expand All @@ -153,9 +153,9 @@ These great services sponsor MUI's core infrastructure:

<div>
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://mui.com/static/readme/netlify-darkmode.svg">
<source media="(prefers-color-scheme: light)" srcset="https://mui.com/static/readme/netlify-lightmode.svg">
<img alt="Netlify logo" src="https://mui.com/static/readme/netlify-lightmode.svg" width="100" height="27">
<source media="(prefers-color-scheme: dark)" srcset="https://v5.mui.com/static/readme/netlify-darkmode.svg">
<source media="(prefers-color-scheme: light)" srcset="https://v5.mui.com/static/readme/netlify-lightmode.svg">
<img alt="Netlify logo" src="https://v5.mui.com/static/readme/netlify-lightmode.svg" width="100" height="27">
</picture>

[Netlify](https://www.netlify.com/) lets us distribute the documentation.
Expand All @@ -164,9 +164,9 @@ These great services sponsor MUI's core infrastructure:

<div>
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://mui.com/static/readme/browserstack-darkmode.svg">
<source media="(prefers-color-scheme: light)" srcset="https://mui.com/static/readme/browserstack-lightmode.svg">
<img alt="BrowserStack logo" src="https://mui.com/static/readme/browserstack-lightmode.svg" width="140" height="25">
<source media="(prefers-color-scheme: dark)" srcset="https://v5.mui.com/static/readme/browserstack-darkmode.svg">
<source media="(prefers-color-scheme: light)" srcset="https://v5.mui.com/static/readme/browserstack-lightmode.svg">
<img alt="BrowserStack logo" src="https://v5.mui.com/static/readme/browserstack-lightmode.svg" width="140" height="25">
</picture>

[BrowserStack](https://www.browserstack.com/) lets us test in real browsers.
Expand Down
2 changes: 1 addition & 1 deletion docs/data/material/getting-started/templates/blog/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@

<!-- #default-branch-switch -->

View the demo at https://mui.com/material-ui/getting-started/templates/blog/.
View the demo at https://v5.mui.com/material-ui/getting-started/templates/blog/.
2 changes: 1 addition & 1 deletion docs/data/material/getting-started/templates/checkout/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@

<!-- #default-branch-switch -->

View the demo at https://mui.com/material-ui/getting-started/templates/checkout/.
View the demo at https://v5.mui.com/material-ui/getting-started/templates/checkout/.
2 changes: 1 addition & 1 deletion docs/data/material/getting-started/templates/dashboard/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@

<!-- #default-branch-switch -->

View the demo at https://mui.com/material-ui/getting-started/templates/dashboard/.
View the demo at https://v5.mui.com/material-ui/getting-started/templates/dashboard/.
2 changes: 1 addition & 1 deletion docs/data/material/getting-started/templates/landing-page/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@

<!-- #default-branch-switch -->

View the demo at https://mui.com/material-ui/getting-started/templates/landing-page/.
View the demo at https://v5.mui.com/material-ui/getting-started/templates/landing-page/.
2 changes: 1 addition & 1 deletion docs/data/material/getting-started/templates/pricing/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@

<!-- #default-branch-switch -->

View the demo at https://mui.com/material-ui/getting-started/templates/pricing/.
View the demo at https://v5.mui.com/material-ui/getting-started/templates/pricing/.
2 changes: 1 addition & 1 deletion docs/data/material/getting-started/templates/sign-in-side/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@

<!-- #default-branch-switch -->

View the demo at https://mui.com/material-ui/getting-started/templates/sign-in-side/.
View the demo at https://v5.mui.com/material-ui/getting-started/templates/sign-in-side/.
2 changes: 1 addition & 1 deletion docs/data/material/getting-started/templates/sign-in/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@

<!-- #default-branch-switch -->

View the demo at https://mui.com/material-ui/getting-started/templates/sign-in/.
View the demo at https://v5.mui.com/material-ui/getting-started/templates/sign-in/.
2 changes: 1 addition & 1 deletion docs/data/material/getting-started/templates/sign-up/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@

<!-- #default-branch-switch -->

View the demo at https://mui.com/material-ui/getting-started/templates/sign-up/.
View the demo at https://v5.mui.com/material-ui/getting-started/templates/sign-up/.
2 changes: 1 addition & 1 deletion docs/data/material/getting-started/templates/sticky-footer/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@

<!-- #default-branch-switch -->

View the demo at https://mui.com/material-ui/getting-started/templates/sticky-footer/.
View the demo at https://v5.mui.com/material-ui/getting-started/templates/sticky-footer/.
2 changes: 1 addition & 1 deletion examples/joy-ui-nextjs-ts/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ or:
To learn more about this example:

- [Next.js documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Customizing Joy UI](https://mui.com/joy-ui/customization/approaches/) - approaches to customizing Joy UI.
- [Customizing Joy UI](https://v5.mui.com/joy-ui/customization/approaches/) - approaches to customizing Joy UI.

## What's next?

Expand Down
2 changes: 1 addition & 1 deletion examples/joy-ui-vite-ts/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Joy UI - Vite.js in TypeScript example

[Joy UI](https://mui.com/joy-ui/getting-started/) is a library of beautifully designed React UI components built to spark joy in the development process.
[Joy UI](https://v5.mui.com/joy-ui/getting-started/) is a library of beautifully designed React UI components built to spark joy in the development process.

[Vite](https://vitejs.dev/) is a build tool that aims to provide a faster and leaner development experience for modern web projects, consisting of a dev server and a build command.

Expand Down
2 changes: 1 addition & 1 deletion examples/material-ui-cra-styled-components-ts/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ npm start

Note that CodeSandbox is not supporting react-app-rewired, yet you can [still see the code](https://codesandbox.io/p/sandbox/github/mui/material-ui/tree/master/examples/material-ui-cra-styled-components-ts).

The following link leverages this demo: https://mui.com/material-ui/integrations/interoperability/#change-the-default-styled-engine with Parcel's alias feature within the `package.json`.
The following link leverages this demo: https://v5.mui.com/material-ui/integrations/interoperability/#change-the-default-styled-engine with Parcel's alias feature within the `package.json`.

[![Edit on CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/p/sandbox/styled-components-interoperability-w9z9d)

Expand Down
2 changes: 1 addition & 1 deletion examples/material-ui-cra-styled-components/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ npm start

Note that CodeSandbox is not supporting react-app-rewired, yet you can [still see the code](https://codesandbox.io/p/sandbox/github/mui/material-ui/tree/master/examples/material-ui-cra-styled-components).

The following link leverages this demo: https://mui.com/material-ui/integrations/interoperability/#change-the-default-styled-engine with Parcel's alias feature within the `package.json`.
The following link leverages this demo: https://v5.mui.com/material-ui/integrations/interoperability/#change-the-default-styled-engine with Parcel's alias feature within the `package.json`.

[![Edit on CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/p/sandbox/styled-components-interoperability-w9z9d)

Expand Down
2 changes: 1 addition & 1 deletion examples/material-ui-express-ssr/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ or:

## The idea behind the example

This is the reference implementation of the [Server Rendering tutorial](https://mui.com/material-ui/guides/server-rendering/).
This is the reference implementation of the [Server Rendering tutorial](https://v5.mui.com/material-ui/guides/server-rendering/).

The example project includes `@mui/material` and its peer dependencies, including [Emotion](https://emotion.sh/docs/introduction), the default style engine in Material UI v5.
If you prefer, you can [use styled-components instead](https://v5.mui.com/material-ui/integrations/interoperability/#styled-components).
Expand Down
2 changes: 1 addition & 1 deletion examples/material-ui-nextjs-ts-v4-v5-migration/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ It includes `@mui/material` and its peer dependencies, including [Emotion](https
It also includes `@mui/styles`, the legacy styling solution that uses JSS as an engine.
It provides all the necessary config for working with both Emotion and JSS for server-side rendering.
The project is intended as a basic starter for migrating your application from v4 to v5, as it lets the JSS style overrides take precedence over the default styles passed to the components by Emotion.
It demonstrates what results after handling v5's breaking changes to the [theme](https://mui.com/material-ui/migration/v5-style-changes/) and [components](https://mui.com/material-ui/migration/v5-component-changes/).
It demonstrates what results after handling v5's breaking changes to the [theme](https://v5.mui.com/material-ui/migration/v5-style-changes/) and [components](https://v5.mui.com/material-ui/migration/v5-component-changes/).

## The Link component

Expand Down
2 changes: 1 addition & 1 deletion examples/material-ui-nextjs-ts/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ or:
To learn more about this example:

- [Next.js documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Customizing Material UI](https://mui.com/material-ui/customization/how-to-customize/) - approaches to customizing Material UI.
- [Customizing Material UI](https://v5.mui.com/material-ui/customization/how-to-customize/) - approaches to customizing Material UI.

## What's next?

Expand Down
2 changes: 1 addition & 1 deletion examples/material-ui-nextjs/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ or:
To learn more about this example:

- [Next.js documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Customizing Material UI](https://mui.com/material-ui/customization/how-to-customize/) - approaches to customizing Material UI.
- [Customizing Material UI](https://v5.mui.com/material-ui/customization/how-to-customize/) - approaches to customizing Material UI.

## What's next?

Expand Down
6 changes: 3 additions & 3 deletions packages/mui-base/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!-- markdownlint-disable-next-line -->
<p align="center">
<a href="https://mui.com/base-ui/" rel="noopener" target="_blank"><img width="150" height="133" src="https://mui.com/static/logo.svg" alt="Base UI logo"></a>
<a href="https://v5.mui.com/base-ui/" rel="noopener" target="_blank"><img width="150" height="133" src="https://v5.mui.com/static/logo.svg" alt="Base UI logo"></a>
</p>

<h1 align="center">Base UI</h1>
Expand All @@ -19,7 +19,7 @@ npm install @mui/base

<!-- #default-branch-switch -->

Visit [https://mui.com/base-ui/](https://mui.com/base-ui/) to view the full documentation.
Visit [https://v5.mui.com/base-ui/](https://v5.mui.com/base-ui/) to view the full documentation.

## Questions

Expand All @@ -35,7 +35,7 @@ Our documentation features [a collection of example projects using Base UI](htt
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 to Base UI is about more than just issues and pull requests!
There are many other ways to [support Base UI](https://mui.com/material-ui/getting-started/faq/#mui-is-awesome-how-can-i-support-the-project) beyond contributing to the code base.
There are many other ways to [support Base UI](https://v5.mui.com/material-ui/getting-started/faq/#mui-is-awesome-how-can-i-support-the-project) beyond contributing to the code base.

## Changelog

Expand Down
2 changes: 1 addition & 1 deletion packages/mui-base/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"bugs": {
"url": "https://github.com/mui/material-ui/issues"
},
"homepage": "https://mui.com/base-ui/",
"homepage": "https://v5.mui.com/base-ui/",
"funding": {
"type": "opencollective",
"url": "https://opencollective.com/mui-org"
Expand Down
Loading

0 comments on commit a58f16b

Please sign in to comment.