diff --git a/.vale.ini b/.vale.ini index 0270cf93..0d8bbaf0 100644 --- a/.vale.ini +++ b/.vale.ini @@ -2,8 +2,12 @@ StylesPath = .github/styles MinAlertLevel = warning -# The docs/mui-vale.zip is generated by `pnpm docs:zipRules` -Packages = Google, docs/mui-vale.zip +# To update mui-vale package: +# 1. Go to the docs folder in the material-ui repo +# 2. Update/create YAML files +# 3. Run `pnpm docs:zipRules` to generate the zip files +# 4. You can test locally by replacing the url with the file path of the generated zip +Packages = Google, https://github.com/mui/material-ui/raw/HEAD/docs/mui-vale.zip [*.md] # Ignore code injections that start with {{... @@ -19,5 +23,5 @@ Google.We = YES # Avoid first-person plural Google.Will = YES # Avoid future tense Google.OxfordComma = YES # Prefer Oxford comma -[*CHANGELOG*.md] +[CHANGELOG*.md] MUI.CorrectReferenceAllCases = NO diff --git a/CHANGELOG.md b/CHANGELOG.md index c1924f31..db10031d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -43,11 +43,11 @@ A big thanks to the 2 contributors who made this release possible. ### Docs -- [docs] Fix Stack Overflow issue canned response @oliviertassinari +- [docs] Fix Stack Overflow issue canned response @oliviertassinari - [docs] Fix outdated link to support page @oliviertassinari - [docs] Keep contributing guide simple (#213) @oliviertassinari - [docs] Fix description of eslint-plugin-material-ui @oliviertassinari -- [docs] Hide a bit the notion of MUI Core @oliviertassinari +- [docs] Hide a bit the notion of MUI Core @oliviertassinari All contributors of this release in alphabetical order: @oliviertassinari, @siriwatknp @@ -82,7 +82,7 @@ A big thanks to the 3 contributors who made this release possible. ### Core -- ​[core] Temporarily fallback to v5 of Material UI (#198) @brijeshb42 +- ​[core] Temporarily fallback to v5 of Material UI (#198) @brijeshb42 - ​[core] Fix event naming convention @oliviertassinari All contributors of this release in alphabetical order: @brijeshb42, @oliviertassinari, @siriwatknp @@ -222,17 +222,17 @@ A big thanks to the 6 contributors who made this release possible. Here are some ### `@pigment-css/react@0.0.12` -- Add `createExtendSxProp` for Material UI integration (#112) @siriwatknp +- Add `createExtendSxProp` for Material UI integration (#112) @siriwatknp - Add `globalCss` processor (#31) @siriwatknp - Implement useTheme processor and runtime theme (#105) @brijeshb42 - Implement variant matching parity (#111) @DiegoAndai - Ignore urls starting with # (#106) @brijeshb42 -- Make theme optional in Pigment CSS config (#108) @brijeshb42 +- Make theme optional in Pigment CSS config (#108) @brijeshb42 ### Docs - Add logo to the README (#121) @danilo-leal -- Add badges like in Material UI @oliviertassinari +- Add badges like in Material UI @oliviertassinari - Fix styleOverrides usage in README (#110) @brijeshb42 - Improve wording (#70) @aarongarciah - Fix roadmap link (#60) @oliviertassinari @@ -323,7 +323,7 @@ Starting with this release, all packages are going to be released under the `lat ### Docs -- [react] Add How Pigment CSS works guide (#18) @brijeshb42 +- [react] Add How Pigment CSS works guide (#18) @brijeshb42 - Update creating a new issue link (#20) @ZeeshanTamboli - Fix wrong header hash in the README.md (#26) @mnajdova diff --git a/README.md b/README.md index dfda06ac..ba18cd99 100644 --- a/README.md +++ b/README.md @@ -514,7 +514,7 @@ globalCss` `; ``` -The `globalCss` function should to be called at the top level of your javascript file, usually from the entry point of the application. +The `globalCss` function should to be called at the top level of your JavaScript file, usually from the entry point of the application. Calling inside a function or a component will not work as expected. Also, the extraction of global styles will always take place regardless of conditional rendering. @@ -725,7 +725,7 @@ declare module '@pigment-css/react/theme' { ## sx prop -A special `sx` prop lets you apply styles directly to an element. When `sx` prop is specified on an element, Pigment CSS will replace it with `className` and `style` props at build time. +A special `sx` prop lets you apply styles directly to an element. When `sx` prop is specified on an element, Pigment CSS will replace it with `className` and `style` props at build time. The `sx` prop works on any element, including HTML elements and 3rd-party custom components as long as it is JSX.