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] Add "Overview" page to Base docs #32310

Merged
merged 15 commits into from
Apr 28, 2022
23 changes: 23 additions & 0 deletions docs/data/base/getting-started/overview/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# MUI Base - Overview

<p class="description">MUI Base is a library of blank ("unstyled") React UI components and low-level hooks, ideally suited for implementing a custom design system.</p>

## Introduction

MUI Base is library of unstyled React UI components.
It features the same robust engineering as Material UI, but without implementing Material Design.

With MUI Base, developers can rapidly build UIs with custom design systems, without the need to override any default style settings.
samuelsycamore marked this conversation as resolved.
Show resolved Hide resolved

## Why use MUI Base?

MUI Base is ideally suited for developers working with a custom design system.
samuelsycamore marked this conversation as resolved.
Show resolved Hide resolved

The library includes prebuilt, unstyled components with production-ready functionality, along with low-level hooks for transferring that functionality to other components.
samuelsycamore marked this conversation as resolved.
Show resolved Hide resolved

### MUI Base vs. Material UI

MUI Base features many of the same components as Material UI, but _without the Material Design implementation_.

You could think of MUI Base as the "skeletal" version of Material UI—foundational components with no built-in style choices.
This makes MUI Base a better option than Material UI if you need to customize the design significantly beyond the Material Design specifications.
samuelsycamore marked this conversation as resolved.
Show resolved Hide resolved
5 changes: 4 additions & 1 deletion docs/data/base/pages.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,10 @@ const pages = [
{
pathname: '/base/getting-started',
icon: 'DescriptionIcon',
children: [{ pathname: '/base/getting-started/installation' }],
children: [
{ pathname: '/base/getting-started/overview', title: 'Overview' },
{ pathname: '/base/getting-started/installation', title: 'Installation' },
],
},
{
pathname: '/base/react-',
Expand Down
11 changes: 11 additions & 0 deletions docs/pages/base/getting-started/overview.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import * as React from 'react';
import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs';
import {
demos,
docs,
demoComponents,
} from 'docs/data/base/getting-started/overview/overview.md?@mui/markdown';

export default function Page() {
return <MarkdownDocs demos={demos} docs={docs} demoComponents={demoComponents} />;
}
1 change: 1 addition & 0 deletions docs/translations/translations.json
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,7 @@
"/system/styles/basics": "Basics",
"/system/styles/advanced": "Advanced",
"/base/getting-started": "Getting started",
"/base/getting-started/overview": "Overview",
"/base/getting-started/installation": "Installation",
"/base/react-": "Components",
"inputs": "Inputs",
Expand Down