Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Fix outdated styled-engine docs #27778

Merged
merged 1 commit into from
Aug 16, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions packages/material-ui-icons/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,7 @@ yarn add @material-ui/core@next

## Documentation

- [The documentation](https://material-ui.com/components/icons/#svg-material-icons)
- [The icons search](https://material-ui.com/components/material-icons/)
<!-- #default-branch-switch -->

- [The documentation](https://next.material-ui.com/components/icons/#svg-material-icons)
- [The icons search](https://next.material-ui.com/components/material-icons/)
4 changes: 3 additions & 1 deletion packages/material-ui-lab/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,6 @@ yarn add @material-ui/core@next

## Documentation

[The documentation](https://material-ui.com/components/about-the-lab/)
<!-- #default-branch-switch -->

[The documentation](https://next.material-ui.com/components/about-the-lab/)
23 changes: 5 additions & 18 deletions packages/material-ui-styled-engine-sc/README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,10 @@
# @material-ui/styled-engine-sc

This package is a wrapper around the `styled-components` package.
It is created to be used as alias for the `@material-ui/styled-engine` package, for the developers who would like to use `styled-components` as a styled engine instead of `@emotion/styled`.
This package is a wrapper around the `styled-components` package implementing the interface of `@material-ui/styled-engine`.
It's designed for developers who would like to use `styled-components` as the main styled engine instead of `@emotion/styled`.

## Installation
## Documentation

The installation of the dependency in your package is slightly different from the usual.
You need to alias the default `emotion` implementation to the `styled-components` one.
Depending on the bundler you are using, you made add it like this:
<!-- #default-branch-switch -->

### webpack

```js
module.exports = {
//...
resolve: {
alias: {
'@material-ui/styled-engine': '@material-ui/styled-engine-sc',
},
},
};
```
[The documentation](https://next.material-ui.com/guides/styled-engine/)
2 changes: 1 addition & 1 deletion packages/material-ui-styled-engine-sc/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"repository": {
"type": "git",
"url": "https://github.com/mui-org/material-ui.git",
"directory": "packages/material-ui-styled"
"directory": "packages/material-ui-styled-engine-sc"
},
"license": "MIT",
"bugs": {
Expand Down
10 changes: 8 additions & 2 deletions packages/material-ui-styled-engine/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# @material-ui/styled-engine

This package is a wrapper around the `@emotion/react` package.
It is used internally in the `@material-ui/core` package.
If you wish to use `styled-components` instead please use an alias to replace this package with `@material-ui/styled-engine-sc`.
It also provides a shared interface that can be used with other styled engines, like styled-components.
It is used internally in the `@material-ui/system` package.

## Documentation

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

[The documentation](https://next.material-ui.com/guides/styled-engine/)
2 changes: 1 addition & 1 deletion packages/material-ui-styled-engine/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"repository": {
"type": "git",
"url": "https://github.com/mui-org/material-ui.git",
"directory": "packages/material-ui-styled"
"directory": "packages/material-ui-styled-engine"
},
"license": "MIT",
"bugs": {
Expand Down
4 changes: 3 additions & 1 deletion packages/material-ui-system/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,6 @@ yarn add @material-ui/system@next @emotion/react @emotion/styled

## Documentation

[The documentation](https://material-ui.com/system/basics/)
<!-- #default-branch-switch -->

[The documentation](https://next.material-ui.com/system/basics/)
4 changes: 3 additions & 1 deletion packages/material-ui-unstyled/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,6 @@ yarn add @material-ui/unstyled@next

## Documentation

[The documentation](https://material-ui.com/)
<!-- #default-branch-switch -->

[The documentation](https://next.material-ui.com/customization/unstyled-components/)