diff --git a/.circleci/config.yml b/.circleci/config.yml index 3422f7adef01d6..e0ed3765608392 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -240,6 +240,11 @@ jobs: command: | yarn extract-error-codes git diff --exit-code + - run: + name: '`yarn docs:link-check` changes committed?' + command: | + yarn docs:link-check + git diff --exit-code test_types: <<: *defaults resource_class: 'medium+' diff --git a/docs/.link-check-errors.txt b/docs/.link-check-errors.txt new file mode 100644 index 00000000000000..4f82b8fd7ece91 --- /dev/null +++ b/docs/.link-check-errors.txt @@ -0,0 +1,4 @@ +Broken links found by `yarn docs:link-check` that exist: + +- https://mui.com/blog/material-ui-v4-is-out/#premium-themes-store-โœจ +- https://mui.com/size-snapshot diff --git a/docs/data/material/experimental-api/css-theme-variables/customization.md b/docs/data/material/experimental-api/css-theme-variables/customization.md index 3b5430235d89db..1a8907a2238fbd 100644 --- a/docs/data/material/experimental-api/css-theme-variables/customization.md +++ b/docs/data/material/experimental-api/css-theme-variables/customization.md @@ -180,7 +180,7 @@ Or use `var()` to refer to the CSS variable directly: ``` :::info -๐Ÿ’ก If you're using a [custom prefix](/material-ui/experimental-api/css-theme-variables/customization/#changing-variable-prefix), make sure to replace the default `--mui`. +๐Ÿ’ก If you're using a [custom prefix](/material-ui/experimental-api/css-theme-variables/customization/#changing-variable-prefixes), make sure to replace the default `--mui`. ::: ### TypeScript diff --git a/docs/data/material/experimental-api/css-theme-variables/usage.md b/docs/data/material/experimental-api/css-theme-variables/usage.md index e58e7691490b59..85df7fc6d130e7 100644 --- a/docs/data/material/experimental-api/css-theme-variables/usage.md +++ b/docs/data/material/experimental-api/css-theme-variables/usage.md @@ -111,7 +111,7 @@ function App() { ``` :::info - ๐Ÿ’ก If you have set up a [custom prefix](/material-ui/experimental-api/css-theme-variables/customization/#changing-variable-prefix), make sure to replace the default `--mui`. + ๐Ÿ’ก If you have set up a [custom prefix](/material-ui/experimental-api/css-theme-variables/customization/#changing-variable-prefixes), make sure to replace the default `--mui`. ::: ## Server-side rendering diff --git a/docs/package.json b/docs/package.json index 1d4dc40cabc154..63478ce01e4137 100644 --- a/docs/package.json +++ b/docs/package.json @@ -15,7 +15,8 @@ "start": "next start", "typescript": "tsc -p tsconfig.json && tsc -p scripts/tsconfig.json", "typescript:transpile": "echo 'Use `yarn docs:typescript:formatted'` instead && exit 1", - "typescript:transpile:dev": "echo 'Use `yarn docs:typescript'` instead && exit 1" + "typescript:transpile:dev": "echo 'Use `yarn docs:typescript'` instead && exit 1", + "link-check": "node ./scripts/reportBrokenLinks.js" }, "dependencies": { "@babel/core": "^7.19.3", diff --git a/docs/pages/blog/2020-q3-update.md b/docs/pages/blog/2020-q3-update.md index 20fc691cee49fe..32e263b60fccf2 100644 --- a/docs/pages/blog/2020-q3-update.md +++ b/docs/pages/blog/2020-q3-update.md @@ -19,7 +19,7 @@ Here are the most significant improvements since June 2020. This was a dense qua - ๐Ÿงช We have promoted 7 components from the lab to the core: Alert, Autocomplete, Pagination, Rating, Skeleton, SpeedDial, and ToggleButton. Thank you for all your feedback on these components. While we still plan a couple of breaking changes on them, we are confident that they have reached the same level of quality as the other core components. -- ๐Ÿ‘ฎ We have introduced a new component in the lab, the [TrapFocus](https://mui.com/base/react-trap-focus/). It manages focus for its descendants. This is useful when implementing overlays such as modal dialogs, which should not allow the focus to escape while open: +- ๐Ÿ‘ฎ We have introduced a new component in the lab, the [TrapFocus](https://mui.com/base/react-focus-trap/). It manages focus for its descendants. This is useful when implementing overlays such as modal dialogs, which should not allow the focus to escape while open: