diff --git a/docs/data/material/integrations/nextjs/nextjs.md b/docs/data/material/integrations/nextjs/nextjs.md index 9eb1c64dea7e78..4a0aaea26add2a 100644 --- a/docs/data/material/integrations/nextjs/nextjs.md +++ b/docs/data/material/integrations/nextjs/nextjs.md @@ -1,6 +1,6 @@ # Next.js integration -

Learn how to use Material UI with Next.js

+

Learn how to use Material UI with Next.js.

## App Router diff --git a/packages/markdown/prepareMarkdown.js b/packages/markdown/prepareMarkdown.js index 69c6c8e7e69589..75254c2800bfa8 100644 --- a/packages/markdown/prepareMarkdown.js +++ b/packages/markdown/prepareMarkdown.js @@ -102,6 +102,12 @@ function prepareMarkdown(config) { ); } + if (description.slice(-1) !== '.' && description.slice(-1) !== '!') { + throw new Error( + `docs-infra: The description "${description}" should end with a "." or "!", those are sentences.`, + ); + } + const contents = getContents(markdown); if (headers.unstyled) { diff --git a/packages/markdown/prepareMarkdown.test.js b/packages/markdown/prepareMarkdown.test.js index 0acb80e3d798c5..111777c4e2743d 100644 --- a/packages/markdown/prepareMarkdown.test.js +++ b/packages/markdown/prepareMarkdown.test.js @@ -13,7 +13,7 @@ describe('prepareMarkdown', () => { const markdown = ` # Support -

Foo

+

Foo.

## Community help (free) ### GitHub GitHub logo @@ -64,7 +64,7 @@ describe('prepareMarkdown', () => { const markdown = ` # Theming -

Foo

+

Foo.

## API ### responsiveFontSizes(theme, options) => theme @@ -105,7 +105,7 @@ describe('prepareMarkdown', () => { const markdownEn = ` # Localization -

Foo

+

Foo.

## Locales ### Example @@ -115,7 +115,7 @@ describe('prepareMarkdown', () => { const markdownPt = ` # Localização -

Foo

+

Foo.

## Idiomas ### Exemplo @@ -125,7 +125,7 @@ describe('prepareMarkdown', () => { const markdownZh = ` # 所在位置 -

Foo

+

Foo.

## 语言环境 ### 例 @@ -211,7 +211,7 @@ describe('prepareMarkdown', () => { const markdownEn = ` # Localization -

Foo

+

Foo.

## Locales ### Example @@ -221,7 +221,7 @@ describe('prepareMarkdown', () => { const markdownPt = ` # Localização -

Foo

+

Foo.

## Idiomas ### Exemplo @@ -292,7 +292,7 @@ describe('prepareMarkdown', () => { const markdown = ` # Localization -

Foo

+

Foo.

[bar](/bar/) [foo](/foo) @@ -314,7 +314,7 @@ See https://ahrefs.com/blog/trailing-slash/ for more details. const markdown = ` # Localization -

Foo

+

Foo.

[bar](/bar/) [foo](foo/) @@ -334,7 +334,7 @@ See https://ahrefs.com/blog/trailing-slash/ for more details. const markdown = ` # Foooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo -

Foo

+

Foo.

`; @@ -354,7 +354,7 @@ https://developers.google.com/search/docs/advanced/appearance/title-link const markdown = ` # Foo -

Fooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo

+

Foooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo.

`; @@ -364,7 +364,7 @@ https://developers.google.com/search/docs/advanced/appearance/title-link translations: [{ filename: 'index.md', markdown, userLanguage: 'en' }], }); }).to - .throw(`docs-infra: The description "Fooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo" is too long (188 characters). + .throw(`docs-infra: The description "Foooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo." is too long (188 characters). It needs to have fewer than 170 characters—ideally less than 160. For more details, see: https://ahrefs.com/blog/meta-description/#4-be-concise `); @@ -374,7 +374,7 @@ https://ahrefs.com/blog/meta-description/#4-be-concise const markdown = ` # Foo -

Fo

+

Fo.

\`\`\`sh npm install @mui/material @@ -401,7 +401,7 @@ Use "bash" instead. const markdown = ` # Localization -

Foo

+

Foo.

[foo](/foo/) [bar](/bar//#foo)