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.

Sign up for GitHub

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

Jump to bottom

[example] Explain package choice #23958

Merged
merged 5 commits into from Dec 12, 2020
Merged

[example] Explain package choice #23958

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c5792e4
updated missing example proejct readme
mnajdova Dec 11, 2020
aa8f4f4
prettier
mnajdova Dec 11, 2020
d888a8d
Update examples/gatsby-theme/README.md
mnajdova Dec 12, 2020
101f365
comments
mnajdova Dec 12, 2020
c777c4d
Link next
oliviertassinari Dec 12, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 1 addition & 2 deletions examples/gatsby-theme/README.md
View file
Open in desktop
Expand Up @@ -25,5 +25,4 @@ or:
This is an alternative example to [`/examples/gatsby`](https://github.com/mui-org/material-ui/tree/next/examples/gatsby) leveraging [gatsby-theme-material-ui](https://github.com/hupe1980/gatsby-theme-material-ui/tree/next/packages/gatsby-theme-material-ui).
The example bundles different Gatsby plugins into a single Gatsby theme.
It trades less freedom for fewer boilerplate.

Additionally, it adds `@material-ui/core` and it's peer dependencies.
It includes `@material-ui/core` and its peer dependencies, including `emotion`, the default style engine in Material-UI v5. If you prefer, you can [use styled-components instead](https://next.material-ui.com/guides/interoperability/#styled-components) instead.
mnajdova marked this conversation as resolved.
Show resolved Hide resolved
3 changes: 1 addition & 2 deletions examples/gatsby/README.md
View file
Open in desktop
Expand Up @@ -22,8 +22,7 @@ or:

## The idea behind the example

[Gatsby](https://github.com/gatsbyjs/gatsby) is a static site generator for React.
Additionally, it adds `@material-ui/core` and it's peer dependencies.
The project uses [Gatsby](https://github.com/gatsbyjs/gatsby), which is a static site generator for React. It includes `@material-ui/core` and its peer dependencies, including `emotion`, the default style engine in Material-UI v5. If you prefer, you can [use styled-components instead](https://next.material-ui.com/guides/interoperability/#styled-components) instead.

## gatsby-theme-material-ui

Expand Down
4 changes: 1 addition & 3 deletions examples/nextjs-with-typescript/README.md
View file
Open in desktop
Expand Up @@ -22,6 +22,4 @@ or:

## The idea behind the example

[Next.js](https://github.com/zeit/next.js) is a framework for server-rendered React apps.

Additionally, it adds `@material-ui/core` and it's peer dependencies.
The project uses [Next.js](https://github.com/zeit/next.js), which is a framework for server-rendered React apps. It includes `@material-ui/core` and its peer dependencies, including `emotion`, the default style engine in Material-UI v5. If you prefer, you can [use styled-components instead](https://next.material-ui.com/guides/interoperability/#styled-components) instead.
4 changes: 1 addition & 3 deletions examples/nextjs/README.md
View file
Open in desktop
Expand Up @@ -22,6 +22,4 @@ or:

## The idea behind the example

[Next.js](https://github.com/zeit/next.js) is a framework for server-rendered React apps.

Additionally, it adds `@material-ui/core` and it's peer dependencies.
The project uses [Next.js](https://github.com/zeit/next.js), which is a framework for server-rendered React apps. It includes `@material-ui/core` and its peer dependencies, including `emotion`, the default style engine in Material-UI v5. If you prefer, you can [use styled-components instead](https://next.material-ui.com/guides/interoperability/#styled-components) instead.
4 changes: 2 additions & 2 deletions examples/preact/README.md
View file
Open in desktop
Expand Up @@ -22,8 +22,8 @@ or:

## The idea behind the example

[Preact](https://github.com/developit/preact) is a fast 3kB alternative to React with the same modern API.
The project uses [Preact](https://github.com/developit/preact), which is a fast 3kB alternative to React with the same modern API.

This example uses CRA with `react-app-rewired` for adding webpack aliases for preact.

Additionally, it adds `@material-ui/core` and it's peer dependencies.
It includes `@material-ui/core` and its peer dependencies, including `emotion`, the default style engine in Material-UI v5. If you prefer, you can [use styled-components instead](https://next.material-ui.com/guides/interoperability/#styled-components) instead.