Skip to content

Commit 83cde7c

Browse files
[docs-infra] Add mdx support to vale lint
1 parent 7957839 commit 83cde7c

File tree

5 files changed

+15
-9
lines changed

5 files changed

+15
-9
lines changed

.vale.ini

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,13 @@ MinAlertLevel = warning
99
# 4. You can test locally by replacing the url with the file path of the generated zip
1010
Packages = Google, https://github.com/mui/material-ui/raw/HEAD/docs/mui-vale.zip
1111

12+
[formats]
13+
mdx = md
14+
1215
[*.md]
16+
# Ignore React component calls
17+
TokenIgnores = (<\/?[A-Z].+>)
18+
1319
# Ignore code injections that start with {{...
1420
BlockIgnores = {{.*
1521

CHANGELOG.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ A big thanks to the 7 contributors who made this release possible. Here are some
4545
- [docs] Avoid dead links in demos (#610) @oliviertassinari
4646
- [docs] Fix rel attribute on edit GitHub links (#614) @oliviertassinari
4747
- [docs] Fix pnpm docs:link-check script (#552) @oliviertassinari
48-
- [docs] Fix Stack Overflow issue canned response @oliviertassinari
48+
- [docs] Fix Stack Overflow issue canned response @oliviertassinari
4949
- [docs] Fix outdated link to support page @oliviertassinari
5050
- [docs] Clarify contribution guide references @oliviertassinari
5151

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

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

docs/data/components/accordion/accordion.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -290,7 +290,7 @@ When using CSS transitions, styles for the `Panel` must be applied to three stat
290290

291291
### JavaScript Animations
292292

293-
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.
293+
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.
294294

295295
```js
296296
function App() {

docs/data/components/collapsible/collapsible.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ When using CSS transitions, styles for the `Panel` must be applied to three stat
147147
148148
### JavaScript Animations
149149
150-
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.
150+
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.
151151
152152
```js
153153
function App() {

docs/data/components/menu/menu.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ Menu items can be used as radio buttons. To group them together, use the `Menu.R
161161
<Demo demo="RadioItems" />
162162

163163
<Callout type="warning">
164-
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.
164+
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.
165165
Unmounting the component resets its state.
166166

167167
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):
@@ -194,7 +194,7 @@ Menu items can act as checkboxes.
194194
<Demo demo="CheckboxItems" />
195195

196196
<Callout type="warning">
197-
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.
197+
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.
198198
Unmounting the component resets its state.
199199

200200
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):

0 commit comments

Comments
 (0)