Skip to content

Commit

Permalink
[docs] Fix various broken master links
Browse files Browse the repository at this point in the history
  • Loading branch information
eps1lon committed Sep 15, 2021
1 parent 4cabf11 commit 040d5fb
Show file tree
Hide file tree
Showing 22 changed files with 46 additions and 46 deletions.
2 changes: 1 addition & 1 deletion docs/pages/blog/december-2019-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Here are the most significant improvements in December:

![Vertical button](/static/blog/december-2019-update/vertical-buttons.png)

- 🌎 We have almost doubled the number of supported [locales](/guides/localization/#localization) from 13 to 22, thanks to our awesome contributors. [Help us](https://github.com/mui-org/material-ui/blob/master/packages/material-ui/src/locale/index.js) double this number next month 🚀!
- 🌎 We have almost doubled the number of supported [locales](/guides/localization/#localization) from 13 to 22, thanks to our awesome contributors. [Help us](https://github.com/mui-org/material-ui/blob/master/packages/mui-material/src/locale/index.ts) double this number next month 🚀!

But this summary is just scratching the surface. We have accepted 168 commits from 73 different contributors. We have changed 1,059 files with 13,468 additions and 8,584 deletions.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ Explore the default theme object:
> as the `theme` variable is exposed on all the documentation pages.
> Please note that **the documentation site is using a custom theme**.
If you want to learn more about how the theme is assembled, take a look at [`material-ui/style/createTheme.js`](https://github.com/mui-org/material-ui/blob/master/packages/material-ui/src/styles/createTheme.js),
If you want to learn more about how the theme is assembled, take a look at [`material-ui/style/createTheme.js`](https://github.com/mui-org/material-ui/blob/v4.x/packages/material-ui/src/styles/createTheme.js),
and the related imports which `createTheme` uses.
2 changes: 1 addition & 1 deletion docs/src/pages/customization/globals/globals.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ const theme = createTheme({

The list of these customization points for each component is documented under the **Component API** section.
For instance, you can have a look at the [Button](/api/button/#css).
Alternatively, you can always have a look at the [implementation](https://github.com/mui-org/material-ui/blob/master/packages/material-ui/src/Button/Button.js).
Alternatively, you can always have a look at the [implementation](https://github.com/mui-org/material-ui/blob/v4.x/packages/material-ui/src/Button/Button.js).

## Global CSS

Expand Down
2 changes: 1 addition & 1 deletion docs/src/pages/customization/z-index/z-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Several Material-UI components utilize `z-index`, employing a default z-index scale in Material-UI
that has been designed to properly layer drawers, modals, snackbars, tooltips, and more.

[These values](https://github.com/mui-org/material-ui/blob/master/packages/material-ui/src/styles/zIndex.js) start at an arbitrary number, high and specific enough to ideally avoid conflicts.
[These values](https://github.com/mui-org/material-ui/blob/v4.x/packages/material-ui/src/styles/zIndex.js) start at an arbitrary number, high and specific enough to ideally avoid conflicts.

- mobile stepper: 1000
- speed dial: 1050
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Two Universal Module Definition (**UMD**) files are provided:
- one for development: https://unpkg.com/@material-ui/core@latest/umd/material-ui.development.js
- one for production: https://unpkg.com/@material-ui/core@latest/umd/material-ui.production.min.js

You can follow [this CDN example](https://github.com/mui-org/material-ui/tree/master/examples/cdn) to quickly get started.
You can follow [this CDN example](https://github.com/mui-org/material-ui/tree/v4.x/examples/cdn) to quickly get started.

⚠️ Using this approach in **production** is **discouraged** though -
the client has to download the entire library, regardless of which components are actually used,
Expand Down
18 changes: 9 additions & 9 deletions docs/src/pages/getting-started/templates/Templates.js
Original file line number Diff line number Diff line change
Expand Up @@ -37,71 +37,71 @@ function layouts(t) {
src: '/static/images/templates/dashboard.png',
href: '/getting-started/templates/dashboard/',
source:
'https://github.com/mui-org/material-ui/tree/master/docs/src/pages/getting-started/templates/dashboard',
'https://github.com/mui-org/material-ui/tree/v4.x/docs/src/pages/getting-started/templates/dashboard',
},
{
title: t('signInTitle'),
description: t('signInDescr'),
src: '/static/images/templates/sign-in.png',
href: '/getting-started/templates/sign-in/',
source:
'https://github.com/mui-org/material-ui/tree/master/docs/src/pages/getting-started/templates/sign-in',
'https://github.com/mui-org/material-ui/tree/v4.x/docs/src/pages/getting-started/templates/sign-in',
},
{
title: t('signInSideTitle'),
description: t('signInSideDescr'),
src: '/static/images/templates/sign-in-side.png',
href: '/getting-started/templates/sign-in-side/',
source:
'https://github.com/mui-org/material-ui/tree/master/docs/src/pages/getting-started/templates/sign-in-side',
'https://github.com/mui-org/material-ui/tree/v4.x/docs/src/pages/getting-started/templates/sign-in-side',
},
{
title: t('signUpTitle'),
description: t('signUpDescr'),
src: '/static/images/templates/sign-up.png',
href: '/getting-started/templates/sign-up/',
source:
'https://github.com/mui-org/material-ui/tree/master/docs/src/pages/getting-started/templates/sign-up',
'https://github.com/mui-org/material-ui/tree/v4.x/docs/src/pages/getting-started/templates/sign-up',
},
{
title: t('blogTitle'),
description: t('blogDescr'),
src: '/static/images/templates/blog.png',
href: '/getting-started/templates/blog/',
source:
'https://github.com/mui-org/material-ui/tree/master/docs/src/pages/getting-started/templates/blog',
'https://github.com/mui-org/material-ui/tree/v4.x/docs/src/pages/getting-started/templates/blog',
},
{
title: t('checkoutTitle'),
description: t('checkoutDescr'),
src: '/static/images/templates/checkout.png',
href: '/getting-started/templates/checkout/',
source:
'https://github.com/mui-org/material-ui/tree/master/docs/src/pages/getting-started/templates/checkout',
'https://github.com/mui-org/material-ui/tree/v4.x/docs/src/pages/getting-started/templates/checkout',
},
{
title: t('albumTitle'),
description: t('albumDescr'),
src: '/static/images/templates/album.png',
href: '/getting-started/templates/album/',
source:
'https://github.com/mui-org/material-ui/tree/master/docs/src/pages/getting-started/templates/album',
'https://github.com/mui-org/material-ui/tree/v4.x/docs/src/pages/getting-started/templates/album',
},
{
title: t('pricingTitle'),
description: t('pricingDescr'),
src: '/static/images/templates/pricing.png',
href: '/getting-started/templates/pricing/',
source:
'https://github.com/mui-org/material-ui/tree/master/docs/src/pages/getting-started/templates/pricing',
'https://github.com/mui-org/material-ui/tree/v4.x/docs/src/pages/getting-started/templates/pricing',
},
{
title: t('stickyFooterTitle'),
description: t('stickyFooterDescr'),
src: '/static/images/templates/sticky-footer.png',
href: '/getting-started/templates/sticky-footer/',
source:
'https://github.com/mui-org/material-ui/tree/master/docs/src/pages/getting-started/templates/sticky-footer',
'https://github.com/mui-org/material-ui/tree/v4.x/docs/src/pages/getting-started/templates/sticky-footer',
},
];
}
Expand Down
2 changes: 1 addition & 1 deletion docs/src/pages/guides/localization/localization.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ const theme = createTheme({
| Ukrainian | uk-UA | `ukUA` |
| Vietnamese | vi-VN | `viVN` |

You can [find the source](https://github.com/mui-org/material-ui/blob/master/packages/material-ui/src/locale/index.ts) in the GitHub repository.
You can [find the source](https://github.com/mui-org/material-ui/blob/v4.x/packages/material-ui/src/locale/index.ts) in the GitHub repository.

To create your own translation, or to customise the English text, copy this file to your project, make any changes needed and import the locale from there.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ If you are using Create React App, you will need to use a couple of projects tha

#### 2. Convert all your imports

Finally, you can convert your existing codebase to this option with this [top-level-imports](https://github.com/mui-org/material-ui/blob/master/packages/material-ui-codemod/README.md#top-level-imports) codemod.
Finally, you can convert your existing codebase to this option with this [top-level-imports](https://github.com/mui-org/material-ui/blob/master/packages/mui-codemod/README.md#top-level-imports) codemod.
It will perform the following diffs:

```diff
Expand Down
8 changes: 4 additions & 4 deletions docs/src/pages/guides/server-rendering/server-rendering.md
Original file line number Diff line number Diff line change
Expand Up @@ -187,11 +187,11 @@ ReactDOM.hydrate(<Main />, document.querySelector('#root'));

## Reference implementations

We host different reference implementations which you can find in the [GitHub repository](https://github.com/mui-org/material-ui) under the [`/examples`](https://github.com/mui-org/material-ui/tree/master/examples) folder:
We host different reference implementations which you can find in the [GitHub repository](https://github.com/mui-org/material-ui) under the [`/examples`](https://github.com/mui-org/material-ui/tree/v4.x/examples) folder:

- [The reference implementation of this tutorial](https://github.com/mui-org/material-ui/tree/master/examples/ssr)
- [Gatsby](https://github.com/mui-org/material-ui/tree/master/examples/gatsby)
- [Next.js](https://github.com/mui-org/material-ui/tree/master/examples/nextjs)
- [The reference implementation of this tutorial](https://github.com/mui-org/material-ui/tree/v4.x/examples/ssr)
- [Gatsby](https://github.com/mui-org/material-ui/tree/v4.x/examples/gatsby)
- [Next.js](https://github.com/mui-org/material-ui/tree/v4.x/examples/nextjs)

## Troubleshooting

Expand Down
2 changes: 1 addition & 1 deletion docs/src/pages/guides/typescript/typescript.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Material-UI requires a minimum version of TypeScript 3.2.

Have a look at the [Create React App with TypeScript](https://github.com/mui-org/material-ui/tree/master/examples/create-react-app-with-typescript) example.
Have a look at the [Create React App with TypeScript](https://github.com/mui-org/material-ui/tree/v4.x/examples/create-react-app-with-typescript) example.

In order for types to work, you have to at least have the following options enabled
in your `tsconfig.json`:
Expand Down
6 changes: 3 additions & 3 deletions docs/src/pages/styles/advanced/advanced.md
Original file line number Diff line number Diff line change
Expand Up @@ -401,13 +401,13 @@ You can [follow the server side guide](/guides/server-rendering/) for a more det
There is [an official Gatsby plugin](https://github.com/hupe1980/gatsby-plugin-material-ui) that enables server-side rendering for `@material-ui/styles`.
Refer to the plugin's page for setup and usage instructions.

Refer to [this example Gatsby project](https://github.com/mui-org/material-ui/blob/master/examples/gatsby) for an up-to-date usage example.
Refer to [this example Gatsby project](https://github.com/mui-org/material-ui/blob/v4.x/examples/gatsby) for an up-to-date usage example.

### Next.js

You need to have a custom `pages/_document.js`, then copy [this logic](https://github.com/mui-org/material-ui/blob/master/examples/nextjs/pages/_document.js) to inject the server-side rendered styles into the `<head>` element.
You need to have a custom `pages/_document.js`, then copy [this logic](https://github.com/mui-org/material-ui/blob/v4.x/examples/nextjs/pages/_document.js) to inject the server-side rendered styles into the `<head>` element.

Refer to [this example project](https://github.com/mui-org/material-ui/blob/master/examples/nextjs) for an up-to-date usage example.
Refer to [this example project](https://github.com/mui-org/material-ui/blob/v4.x/examples/nextjs) for an up-to-date usage example.

## Class names

Expand Down
2 changes: 1 addition & 1 deletion docs/src/pages/styles/basics/basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ and **unlocks many great features** (theme nesting, dynamic styles, self-support
Material-UI's styling solution is inspired by many other styling libraries such as [styled-components](https://www.styled-components.com/) and [emotion](https://emotion.sh/).

- 💅 You can expect [the same advantages](https://www.styled-components.com/docs/basics#motivation) as styled-components.
- 🚀 It's [blazing fast](https://github.com/mui-org/material-ui/blob/master/packages/material-ui-benchmark/README.md#material-uistyles).
- 🚀 It's [blazing fast](https://github.com/mui-org/material-ui/blob/v4.x/packages/material-ui-benchmark/README.md#material-uistyles).
- 🧩 It's extensible via a [plugin](https://github.com/cssinjs/jss/blob/master/docs/plugins.md) API.
- ⚡️ It uses [JSS](https://github.com/cssinjs/jss) at its core – a [high performance](https://github.com/cssinjs/jss/blob/master/docs/performance.md) JavaScript to CSS compiler which works at runtime and server-side.
- 📦 Less than [15 KB gzipped](https://bundlephobia.com/result?p=@material-ui/styles); and no bundle size increase if used alongside Material-UI.
Expand Down
2 changes: 1 addition & 1 deletion docs/src/pages/system/basics/basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
- 🦎 Work with any theme object.
- 💅 Work with the most popular CSS-in-JS solutions.
- 📦 Less than [4 KB gzipped](https://bundlephobia.com/result?p=@material-ui/system).
- 🚀 [Fast enough](https://github.com/mui-org/material-ui/blob/master/packages/material-ui-benchmark/README.md#material-uisystem) not to be a bottleneck at runtime.
- 🚀 [Fast enough](https://github.com/mui-org/material-ui/blob/v4.x/packages/material-ui-benchmark/README.md#material-uisystem) not to be a bottleneck at runtime.

It's important to understand that this package exposes pure (side-effect free) style functions with this signature: `({ theme, ...style }) => style`, **that's it**.

Expand Down
4 changes: 2 additions & 2 deletions examples/create-react-app-with-typescript/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Download the example [or clone the repo](https://github.com/mui-org/material-ui):

```sh
curl https://codeload.github.com/mui-org/material-ui/tar.gz/master | tar -xz --strip=2 material-ui-master/examples/create-react-app-with-typescript
curl https://codeload.github.com/mui-org/material-ui/tar.gz/v4.x | tar -xz --strip=2 material-ui-master/examples/create-react-app-with-typescript
cd create-react-app-with-typescript
```

Expand All @@ -18,7 +18,7 @@ npm start

or:

[![Edit on CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/mui-org/material-ui/tree/master/examples/create-react-app-with-typescript)
[![Edit on CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/mui-org/material-ui/tree/v4.x/examples/create-react-app-with-typescript)

## The idea behind the example

Expand Down
4 changes: 2 additions & 2 deletions examples/create-react-app/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Download the example [or clone the repo](https://github.com/mui-org/material-ui):

```sh
curl https://codeload.github.com/mui-org/material-ui/tar.gz/master | tar -xz --strip=2 material-ui-master/examples/create-react-app
curl https://codeload.github.com/mui-org/material-ui/tar.gz/v4.x | tar -xz --strip=2 material-ui-master/examples/create-react-app
cd create-react-app
```

Expand All @@ -18,7 +18,7 @@ npm start

or:

[![Edit on CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/mui-org/material-ui/tree/master/examples/create-react-app)
[![Edit on CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/mui-org/material-ui/tree/v4.x/examples/create-react-app)

## The idea behind the example

Expand Down
6 changes: 3 additions & 3 deletions examples/gatsby-theme/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Download the example [or clone the repo](https://github.com/mui-org/material-ui):

```sh
curl https://codeload.github.com/mui-org/material-ui/tar.gz/master | tar -xz --strip=2 material-ui-master/examples/gatsby-theme
curl https://codeload.github.com/mui-org/material-ui/tar.gz/v4.x | tar -xz --strip=2 material-ui-master/examples/gatsby-theme
cd gatsby-theme
```

Expand All @@ -18,10 +18,10 @@ npm run develop

or:

[![Edit on CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/mui-org/material-ui/tree/master/examples/gatsby-theme)
[![Edit on CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/mui-org/material-ui/tree/v4.x/examples/gatsby-theme)

## The idea behind the example

This is an alternative example to [`/examples/gatsby`](https://github.com/mui-org/material-ui/tree/master/examples/gatsby) leveraging [gatsby-theme-material-ui](https://github.com/hupe1980/gatsby-theme-material-ui/tree/master/packages/gatsby-theme-material-ui).
This is an alternative example to [`/examples/gatsby`](https://github.com/mui-org/material-ui/tree/v4.x/examples/gatsby) leveraging [gatsby-theme-material-ui](https://github.com/hupe1980/gatsby-theme-material-ui/tree/v4.x/packages/gatsby-theme-material-ui).
The example bundles different Gatsby plugins into a single Gatsby theme.
It trades less freedom for fewer boilerplate.
6 changes: 3 additions & 3 deletions examples/gatsby/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Download the example [or clone the repo](https://github.com/mui-org/material-ui):

```sh
curl https://codeload.github.com/mui-org/material-ui/tar.gz/master | tar -xz --strip=2 material-ui-master/examples/gatsby
curl https://codeload.github.com/mui-org/material-ui/tar.gz/v4.x | tar -xz --strip=2 material-ui-master/examples/gatsby
cd gatsby
```

Expand All @@ -18,7 +18,7 @@ npm run develop

or:

[![Edit on CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/mui-org/material-ui/tree/master/examples/gatsby)
[![Edit on CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/mui-org/material-ui/tree/v4.x/examples/gatsby)

## The idea behind the example

Expand All @@ -27,4 +27,4 @@ or:
## gatsby-theme-material-ui

Looking for an example with less boilerplate but also less freedom?
Check [`/examples/gatsby-theme`](https://github.com/mui-org/material-ui/tree/master/examples/gatsby-theme) out.
Check [`/examples/gatsby-theme`](https://github.com/mui-org/material-ui/tree/v4.x/examples/gatsby-theme) out.
4 changes: 2 additions & 2 deletions examples/nextjs-with-typescript/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Download the example [or clone the repo](https://github.com/mui-org/material-ui):

```sh
curl https://codeload.github.com/mui-org/material-ui/tar.gz/master | tar -xz --strip=2 material-ui-master/examples/nextjs-with-typescript
curl https://codeload.github.com/mui-org/material-ui/tar.gz/v4.x | tar -xz --strip=2 material-ui-master/examples/nextjs-with-typescript
cd nextjs-with-typescript
```

Expand All @@ -18,7 +18,7 @@ npm run dev

or:

[![Edit on CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/mui-org/material-ui/tree/master/examples/nextjs-with-typescript)
[![Edit on CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/mui-org/material-ui/tree/v4.x/examples/nextjs-with-typescript)

## The idea behind the example

Expand Down
4 changes: 2 additions & 2 deletions examples/nextjs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Download the example [or clone the repo](https://github.com/mui-org/material-ui):

```sh
curl https://codeload.github.com/mui-org/material-ui/tar.gz/master | tar -xz --strip=2 material-ui-master/examples/nextjs
curl https://codeload.github.com/mui-org/material-ui/tar.gz/v4.x | tar -xz --strip=2 material-ui-master/examples/nextjs
cd nextjs
```

Expand All @@ -18,7 +18,7 @@ npm run dev

or:

[![Edit on CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/mui-org/material-ui/tree/master/examples/nextjs)
[![Edit on CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/mui-org/material-ui/tree/v4.x/examples/nextjs)

## The idea behind the example

Expand Down
4 changes: 2 additions & 2 deletions examples/preact/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Download the example [or clone the repo](https://github.com/mui-org/material-ui):

```sh
curl https://codeload.github.com/mui-org/material-ui/tar.gz/master | tar -xz --strip=2 material-ui-master/examples/preact
curl https://codeload.github.com/mui-org/material-ui/tar.gz/v4.x | tar -xz --strip=2 material-ui-master/examples/preact
cd preact
```

Expand All @@ -17,7 +17,7 @@ npm run start
```
or:

[![Edit on CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/mui-org/material-ui/tree/master/examples/preact)
[![Edit on CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/mui-org/material-ui/tree/v4.x/examples/preact)

## The idea behind the example

Expand Down
2 changes: 1 addition & 1 deletion framer/Material-UI.framerfx/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ If multiple options are supplied, they take the following priority:
## Resources

- [Material-UI documentation](https://material-ui.com/)
- [GitHub repo](https://github.com/mui-org/material-ui/tree/master/framer)
- [GitHub repo](https://github.com/mui-org/material-ui/tree/v4.x/framer)

## Releases

Expand Down
Loading

0 comments on commit 040d5fb

Please sign in to comment.