Skip to content

chore(i18n, api): generate component API partials as .mdx - #4685

Merged
thetaPC merged 1 commit into
translation/jpfrom
FW-6456-pt4b-jp
Aug 31, 2026
Merged

chore(i18n, api): generate component API partials as .mdx#4685
thetaPC merged 1 commit into
translation/jpfrom
FW-6456-pt4b-jp

Conversation

@thetaPC

@thetaPC thetaPC commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

Issue URL: internal

What is the current behavior?

The component API tables are generated at build time into .docusaurus, and this branch's copy of the plugin writes them with .md names. Only custom-props is already .mdx.

That is the state main was in before it moved these partials to .mdx. Because this branch is a full fork of the repository rather than a prose only branch, its preview build resolves imports against this copy of the plugin, not against main's, so the change has to be made here too.

Nothing on this branch can move to the .mdx names until it is: an import written as .mdx would point at a file the plugin never writes.

What is the new behavior?

The plugin now writes all six partials as .mdx, and continues to write five of them as .md alongside. It also gains a resolve.extensionAlias entry mapping .md to .mdx and then .md.

Nothing changes today. This branch's 465 docs imports and the 94 in versioned_docs/version-v8 all still use the .md names and all still resolve. The point is that the .mdx names now exist, so the pages can be moved over in a follow-up rather than in one commit alongside a plugin change.

Both transitional pieces carry a TODO(FW-6456) note and come out once every page on this branch imports the .mdx names.

This is the same change main made in #4640, applied to this branch's copy. Only the generated output and the resolver entry are ported. The node-fetch import that main has since dropped is left alone, since that is a separate change.

Does this introduce a breaking change?

  • Yes
  • No

Other information

This does not depend on anything landing on main first, and nothing on main depends on it. It only affects how this branch's own preview build resolves the generated partials, so it can merge at any point.

The follow-up PR is what actually moves this branch's pages: 266 renames, 381 internal links, and the 470 imports. That one needs this to be in place first.

Verified locally with a full build of this branch: 2326 pages, 0 errors, no unresolved modules. The plugin writes 1728 .mdx partials and 1440 .md partials, which is six and five per component respectively, the difference being that custom-props was already .mdx and needs no duplicate.

How to test

Open any component API page, for example Button, and confirm the Properties, Events, Methods, Parts, Custom Properties, and Slots tables all render. Those tables are the generated partials, so an empty or missing section is what a failure looks like.

Check one v8 page too, for example Button, v8, since those pages import the .md names and confirm the old names are still being written.

@vercel

vercel Bot commented Aug 31, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
ionic-docs Ready Ready Preview Aug 31, 2026 9:24pm

Request Review

@thetaPC
thetaPC marked this pull request as ready for review August 31, 2026 21:30
@thetaPC
thetaPC requested a review from a team as a code owner August 31, 2026 21:30
@thetaPC
thetaPC requested review from OS-jacobbell and removed request for a team August 31, 2026 21:30
@thetaPC
thetaPC merged commit 623a50d into translation/jp Aug 31, 2026
4 checks passed
@thetaPC
thetaPC deleted the FW-6456-pt4b-jp branch August 31, 2026 21:34
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.

2 participants