Skip to content

Commit

Permalink
[docs-infra] Add mdx support to vale lint (#769)
Browse files Browse the repository at this point in the history
  • Loading branch information
oliviertassinari authored Nov 1, 2024
1 parent 6abbb3b commit 48c675b
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 10 deletions.
6 changes: 6 additions & 0 deletions .vale.ini
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,13 @@ MinAlertLevel = warning
# 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

[formats]
mdx = md

[*.md]
# Ignore React component calls
TokenIgnores = (<\/?[A-Z].+>)

# Ignore code injections that start with {{...
BlockIgnores = {{.*

Expand Down
12 changes: 6 additions & 6 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ A big thanks to the 7 contributors who made this release possible. Here are some
- [docs] Avoid dead links in demos (#610) @oliviertassinari
- [docs] Fix rel attribute on edit GitHub links (#614) @oliviertassinari
- [docs] Fix pnpm docs:link-check script (#552) @oliviertassinari
- [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] Clarify contribution guide references @oliviertassinari

Expand All @@ -54,27 +54,27 @@ A big thanks to the 7 contributors who made this release possible. Here are some
- [code-infra] Remove custom playwright installation steps (#646) @Janpot
- [core] Fix 301 link to Next.js and git diff @oliviertassinari
- [core] Fix package.json repository rule @oliviertassinari
- [core] MUI X repository moved to a new location @oliviertassinari
- [core] MUI X repository moved to a new location @oliviertassinari
- [core] React 19 compatibility (#605) @michaldudak
- [core] Reference `ownerDocument` (#660) @atomiks
- [core] Remove 'use client' from index files (#331) @michaldudak
- [core] Remove /.yarn (#596) @oliviertassinari
- [core] Remove Material UI dependency (#585) @michaldudak
- [core] Remove Material UI dependency (#585) @michaldudak
- [core] Remove the legacy components from the repo (#584) @michaldudak
- [core] Rename positionStrategy to positionMethod (#704) @michaldudak
- [docs-infra] Fix double // (#613) @oliviertassinari
- [docs-infra] Strengthen CSP (#595) @oliviertassinari
- [infra] Adds reusable workflow for closing message on issues (#598) @michelengelen
- [infra] Adds reusable workflow for issue cleanup (#597) @michelengelen
- [infra] Fix line break in Stack Overflow message @oliviertassinari
- [infra] Fix line break in Stack Overflow message @oliviertassinari
- [test] Fix tests on Safari (#546) @michaldudak
- [test] Fix the test_types_next CI job (#703) @michaldudak
- [test] Improve visual screenshot canva (#708)
- [test] Point Istanbul to correct URL (#657) @sai6855
- [test] Run Browserstack tests on master only (#578) @michaldudak
- [test] Use `waitFor` instead of fixed timeout in tests (#632) @michaldudak
- [website] Improve utm_source strategy @oliviertassinari
- [website] Modernize the Base UI website (#538) @michaldudak
- [website] Modernize the Base UI website (#538) @michaldudak

All contributors of this release in alphabetical order: @atomiks, @Janpot, @michaldudak, @michelengelen, @mj12albert, @oliviertassinari, @sai6855

Expand Down Expand Up @@ -110,7 +110,7 @@ A big thanks to the 10 contributors who made this release possible. Here are som

### Docs

- [docs] Add badges like in Material UI @oliviertassinari
- [docs] Add badges like in Material UI @oliviertassinari
- [docs] Add the logo to the README (#448) @danilo-leal
- [docs] Convert alpha component docs to new docs template (#392) @colmtuite
- [docs] Correct Bundlephobia links (#419) @michaldudak
Expand Down
2 changes: 1 addition & 1 deletion docs/data/components/accordion/accordion.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,7 @@ When using CSS transitions, styles for the `Panel` must be applied to three stat

### JavaScript Animations

When using external libraries for animation, for example `framer-motion`, be aware that `Accordion.Item`s hides content using the html `hidden` attribute in the closed state, and does not unmount from the DOM.
When using external libraries for animation, for example `framer-motion`, be aware that `Accordion.Item`s hides content using the HTML `hidden` attribute in the closed state, and does not unmount from the DOM.

```js
function App() {
Expand Down
2 changes: 1 addition & 1 deletion docs/data/components/collapsible/collapsible.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ When using CSS transitions, styles for the `Panel` must be applied to three stat
### JavaScript Animations
When using external libraries for animation, for example `framer-motion`, be aware that Collapsible hides content using the html `hidden` attribute in the closed state, and does not unmount the `Collapsible.Panel` subcomponent.
When using external libraries for animation, for example `framer-motion`, be aware that Collapsible hides content using the HTML `hidden` attribute in the closed state, and does not unmount the `Collapsible.Panel` subcomponent.
```js
function App() {
Expand Down
4 changes: 2 additions & 2 deletions docs/data/components/menu/menu.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ Menu items can be used as radio buttons. To group them together, use the `Menu.R
<Demo demo="RadioItems" />

<Callout type="warning">
If you rely on the RadioItem to manage its state (e.g., you use the `defaultChecked` and `onCheckedChange` props), ensure that the item is not unmounted when its parent menu is closed.
If you rely on the RadioItem to manage its state (for example, you use the `defaultChecked` and `onCheckedChange` props), ensure that the item is not unmounted when its parent menu is closed.
Unmounting the component resets its state.

To do this, add the `keepMounted` prop to the `Menu.Positioner` the checkbox item is in (and all parent positioners, in the case of a nested menu):
Expand Down Expand Up @@ -194,7 +194,7 @@ Menu items can act as checkboxes.
<Demo demo="CheckboxItems" />

<Callout type="warning">
If you rely on the CheckboxItem to manage its state (e.g., you use the `defaultChecked` and `onCheckedChange` props), ensure that the item is not unmounted when its parent menu is closed.
If you rely on the CheckboxItem to manage its state (for example, you use the `defaultChecked` and `onCheckedChange` props), ensure that the item is not unmounted when its parent menu is closed.
Unmounting the component resets its state.

To do this, add the `keepMounted` prop to the `Menu.Positioner` the checkbox item is in (and all parent positioners, in the case of a nested menu):
Expand Down

0 comments on commit 48c675b

Please sign in to comment.