Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thetaPC merged 1 commit into from
Aug 31, 2026
Merged

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 27 additions & 1 deletion plugins/docusaurus-plugin-ionic-component-api/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,12 +89,27 @@ module.exports = function (context, options) {
* createData will create a file within the generated ./docusaurus
* directory within the plugin directory.
*/
promises.push(
createData(`${basePath}/props.mdx`, data.props),
createData(`${basePath}/events.mdx`, data.events),
createData(`${basePath}/methods.mdx`, data.methods),
createData(`${basePath}/parts.mdx`, data.parts),
createData(`${basePath}/custom-props.mdx`, data.customProps),
createData(`${basePath}/slots.mdx`, data.slots)
);

/**
* TODO(FW-6456): Remove once every page on this branch imports the `.mdx` names.
*
* Transitional: this branch's `docs/` pages and its `versioned_docs` copies still
* import the `.md` names. Those are rewritten separately, so the old names have to
* keep being emitted until they are.
*/
promises.push(
createData(`${basePath}/props.md`, data.props),
createData(`${basePath}/events.md`, data.events),
createData(`${basePath}/methods.md`, data.methods),
createData(`${basePath}/parts.md`, data.parts),
createData(`${basePath}/custom-props.mdx`, data.customProps),
createData(`${basePath}/slots.md`, data.slots)
);
}
Expand All @@ -112,6 +127,17 @@ module.exports = function (context, options) {
alias: {
'@ionic-internal/component-api': `${context.siteDir}/.docusaurus/docusaurus-plugin-ionic-component-api/default`,
},
/**
* TODO(FW-6456): Remove once every page on this branch imports the `.mdx` names.
*
* Lets a `.md` import resolve to a `.mdx` file, so pages can be moved over in
* batches rather than all at once. Matches the entry on `main`.
*
* Applies to every `.md` import, so a stale `.mdx` next to a `.md` will shadow it.
*/
extensionAlias: {
'.md': ['.mdx', '.md'],
},
},
};
},
Expand Down