Skip to content

chore(prettier): keep each paragraph on one line - #4859

Draft
thetaPC wants to merge 2 commits into
mainfrom
prose-wrap
Draft

thetaPC wants to merge 2 commits into
mainfrom
prose-wrap

Conversation

@thetaPC

@thetaPC thetaPC commented Nov 18, 2026 •

Copy link
Copy Markdown
Contributor

Issue URL: N/A

What is the current behavior?

  • 186 line breaks fall in the middle of a paragraph across the docs markdown.
  • Prettier keeps whatever wrapping the author used, so nothing stops new ones.

What is the new behavior?

  • Prettier runs with proseWrap: 'never' on .md and .mdx, except CONTRIBUTING.md, where GitHub alerts need > [!NOTE] on its own line. npm run lint puts each paragraph on one line, so the Lint job fails on a new break.
  • Joins the 186 existing breaks in the docs.
  • Tables wider than 120 characters lose their column padding: 683 rows in 52 files. Prettier ties this to proseWrap, with no option to keep one without the other.
  • Adds a blank line between a {/* */} comment and the import below it on 8 API pages, and inside 5 admonitions. Without them, Prettier merges the lines: the API pages fail to build, and the admonition pages show a literal :::note.
  • CONTRIBUTING asks for the admonition blank lines.

Does this introduce a breaking change?

  • Yes
  • No

Other information

The rendered site doesn't change. A build of this branch matches main on all 11,699 pages and Markdown versions, ignoring whitespace.

Two JSX text breaks remain, in components.mdx and play-store.mdx plus their v8 copies. Prettier re-wraps JSX text, so it would undo a manual join.

@vercel

vercel Bot commented Nov 18, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
ionic-docs Ready Ready Preview Nov 18, 2026 12:15am UTC

Request Review

This branch was successfully deployed

1 active deployment
Preview — c5d439f7 Deployed Nov 18, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant