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

[material-ui][docs] Add a "start now" section on the Overview page #41137

Merged
merged 2 commits into from
Feb 20, 2024
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
14 changes: 9 additions & 5 deletions docs/data/material/getting-started/overview/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,10 @@

Material UI is an open-source React component library that implements Google's [Material Design](https://m2.material.io/).

It includes a comprehensive collection of prebuilt components that are ready for use in production right out of the box.

Material UI is beautiful by design and features a suite of customization options that make it easy to implement your own custom design system on top of our components.
It includes a comprehensive collection of prebuilt components that are ready for use in production right out of the box, and features a suite of customization options that make it easy to implement your own custom design system on top of our components.

Check warning on line 13 in docs/data/material/getting-started/overview/overview.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": "docs/data/material/getting-started/overview/overview.md", "range": {"start": {"line": 13, "column": 239}}}, "severity": "WARNING"}

:::info
Material UI v5 supports Material Design v2.
Material UI v5 supports Material Design 2.
Adoption of Material Design 3 is tentatively planned for Material UI v6—see [the announcement blog post](/blog/2023-material-ui-v6-and-beyond/) for more details.
You can follow [this GitHub issue](https://github.com/mui/material-ui/issues/29345) for future updates.
:::
Expand All @@ -33,10 +31,16 @@
It's almost as old as React itself—its history stretches back to 2014—and we're in this for the long haul.
You can count on the community's support for years to come (e.g. [Stack Overflow](https://insights.stackoverflow.com/trends?tags=material-ui)).

## Material UI vs. Base UI
### Material UI vs. Base UI

Material UI and [Base UI](/base-ui/) feature many of the same UI components, but Base UI comes without any default styles or styling solutions.

Material UI is _comprehensive_ in that it comes packaged with default styles, and is optimized to work with [Emotion](https://emotion.sh/docs/introduction) (or [styled-components](https://styled-components.com/)).

Base UI, by contrast, could be considered the "skeletal" or "headless" counterpart to Material UI—in fact, future versions of Material UI will use Base UI components and hooks for its foundational structure.

## Start now

Get started with Material UI today through some of these useful resources:

{{"component": "modules/components/MaterialStartingLinksCollection.js"}}
74 changes: 74 additions & 0 deletions docs/src/modules/components/MaterialStartingLinksCollection.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
import * as React from 'react';
import Grid from '@mui/material/Unstable_Grid2';
import InstallDesktopRoundedIcon from '@mui/icons-material/InstallDesktopRounded';
import WebRoundedIcon from '@mui/icons-material/WebRounded';
import DrawRoundedIcon from '@mui/icons-material/DrawRounded';
import PlayCircleFilledWhiteRoundedIcon from '@mui/icons-material/PlayCircleFilledWhiteRounded';
import DesignServicesRoundedIcon from '@mui/icons-material/DesignServicesRounded';
import InfoCard from 'docs/src/components/action/InfoCard';

const content = [
{
title: 'Installation',
description: 'Add Material UI to your project with a few commands.',
link: '/material-ui/getting-started/installation/',
icon: <InstallDesktopRoundedIcon color="primary" />,
},
{
title: 'Usage',
description: 'Learn the basics about Material UI components.',
link: '/material-ui/getting-started/usage/',
icon: <DrawRoundedIcon color="primary" />,
},
{
title: 'Example projects',
description: 'A collection of boilerplates to jumpstart your next project.',
link: '/material-ui/getting-started/example-projects/',
icon: <PlayCircleFilledWhiteRoundedIcon color="primary" />,
},
{
title: 'Customizing components',
description: 'Learn about the available customization methods.',
link: '/material-ui/customization/how-to-customize/',
icon: <DesignServicesRoundedIcon color="primary" />,
},
{
title: 'Templates',
zanivan marked this conversation as resolved.
Show resolved Hide resolved
description: 'Get started with a selection of free templates.',
link: '/material-ui/getting-started/templates/',
icon: <WebRoundedIcon color="primary" />,
},
{
title: 'Design resources',
description: 'The Material UI components in your favorite design tool.',
link: 'https://www.figma.com/community/file/912837788133317724/material-ui-for-figma-and-mui-x',
icon: (
<img
src={`/static/branding/design-kits/figma-logo.svg`}
alt="Figma logo"
loading="lazy"
width="24"
height="24"
/>
),
},
];

export default function MaterialStartingLinksCollection() {
return (
<Grid container spacing={2}>
{content.map(({ icon, title, description, link }) => (
<Grid key={title} xs={12} sm={6} md={4}>
<InfoCard
classNameTitle="algolia-lvl3"
classNameDescription="algolia-content"
link={link}
title={title}
icon={icon}
description={description}
/>
</Grid>
))}
</Grid>
);
}
Loading