[code-infra] Prepare the markdown package for publishing (#41240)

.codesandbox/ci.json

@@ -4,6 +4,7 @@
   "node": "18",
   "packages": [
     "packages/docs-utils",
+    "packages/markdown",
     "packages/mui-babel-macros",
     "packages/mui-base",
     "packages/mui-codemod",
@@ -33,6 +34,7 @@
     "@mui/core-downloads-tracker": "packages/mui-core-downloads-tracker/build",
     "@mui/icons-material": "packages/mui-icons-material/build",
     "@mui/internal-babel-macros": "packages/mui-babel-macros",
+    "@mui/internal-markdown": "packages/markdown",
     "@mui/internal-scripts": "packages-internal/scripts",
     "@mui/joy": "packages/mui-joy/build",
     "@mui/lab": "packages/mui-lab/build",

babel.config.js

@@ -22,7 +22,7 @@ module.exports = function getBabelConfig(api) {
       `./packages/mui-icons-material/lib${useESModules ? '/esm' : ''}`,
     ),
     '@mui/lab': resolveAliasPath('./packages/mui-lab/src'),
-    '@mui/markdown': resolveAliasPath('./packages/markdown'),
+    '@mui/internal-markdown': resolveAliasPath('./packages/markdown'),
     '@mui/styled-engine': resolveAliasPath('./packages/mui-styled-engine/src'),
     '@mui/styled-engine-sc': resolveAliasPath('./packages/mui-styled-engine-sc/src'),
     '@mui/styles': resolveAliasPath('./packages/mui-styles/src'),

docs/lib/sourcing.ts

@@ -1,6 +1,6 @@
 import fs from 'fs';
 import path from 'path';
-import { getHeaders } from '@mui/markdown';
+import { getHeaders } from '@mui/internal-markdown';
 
 const blogDir = path.join(process.cwd(), 'pages/blog');
 

docs/next.config.mjs

@@ -129,14 +129,33 @@ export default withDocsInfra({
             test: /\.md$/,
             oneOf: [
               {
-                resourceQuery: /@mui\/markdown/,
+                resourceQuery: /muiMarkdown/,
                 use: [
                   options.defaultLoaders.babel,
                   {
-                    loader: require.resolve('@mui/markdown/loader'),
+                    loader: require.resolve('@mui/internal-markdown/loader'),
                     options: {
+                      workspaceRoot,
                       ignoreLanguagePages: LANGUAGES_IGNORE_PAGES,
                       languagesInProgress: LANGUAGES_IN_PROGRESS,
+                      packages: [
+                        {
+                          productId: 'material-ui',
+                          paths: [
+                            path.join(workspaceRoot, 'packages/mui-base/src'),
+                            path.join(workspaceRoot, 'packages/mui-lab/src'),
+                            path.join(workspaceRoot, 'packages/mui-material/src'),
+                          ],
+                        },
+                        {
+                          productId: 'base-ui',
+                          paths: [path.join(workspaceRoot, 'packages/mui-base/src')],
+                        },
+                        {
+                          productId: 'joy-ui',
+                          paths: [path.join(workspaceRoot, 'packages/mui-joy/src')],
+                        },
+                      ],
                       env: {
                         SOURCE_CODE_REPO: options.config.env.SOURCE_CODE_REPO,
                         LIB_VERSION: options.config.env.LIB_VERSION,

docs/package.json

@@ -36,7 +36,7 @@
     "@mui/icons-material": "workspace:^",
     "@mui/joy": "workspace:*",
     "@mui/lab": "workspace:*",
-    "@mui/markdown": "workspace:^",
+    "@mui/internal-markdown": "workspace:^",
     "@mui/material": "workspace:^",
     "@mui/material-next": "workspace:*",
     "@mui/styled-engine": "workspace:^",

docs/pages/base-ui/all-components/index.js

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
 import AppFrame from 'docs/src/modules/components/AppFrame';
-import * as pageProps from 'docs/data/base/all-components/all-components.md?@mui/markdown';
+import * as pageProps from 'docs/data/base/all-components/all-components.md?muiMarkdown';
 
 export default function Page() {
   return <MarkdownDocs {...pageProps} disableToc />;

docs/pages/base-ui/getting-started/accessibility.js

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
 import AppFrame from 'docs/src/modules/components/AppFrame';
-import * as pageProps from 'docs/data/base/getting-started/accessibility/accessibility.md?@mui/markdown';
+import * as pageProps from 'docs/data/base/getting-started/accessibility/accessibility.md?muiMarkdown';
 
 export default function Page() {
   return <MarkdownDocs {...pageProps} />;

docs/pages/base-ui/getting-started/customization.js

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
 import AppFrame from 'docs/src/modules/components/AppFrame';
-import * as pageProps from 'docs/data/base/getting-started/customization/customization.md?@mui/markdown';
+import * as pageProps from 'docs/data/base/getting-started/customization/customization.md?muiMarkdown';
 
 export default function Page() {
   return <MarkdownDocs {...pageProps} />;

docs/pages/base-ui/getting-started/index.js

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
 import AppFrame from 'docs/src/modules/components/AppFrame';
-import * as pageProps from 'docs/data/base/getting-started/overview/overview.md?@mui/markdown';
+import * as pageProps from 'docs/data/base/getting-started/overview/overview.md?muiMarkdown';
 
 export default function Page() {
   return <MarkdownDocs {...pageProps} disableAd />;

docs/pages/base-ui/getting-started/quickstart.js

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
 import AppFrame from 'docs/src/modules/components/AppFrame';
-import * as pageProps from 'docs/data/base/getting-started/quickstart/quickstart.md?@mui/markdown';
+import * as pageProps from 'docs/data/base/getting-started/quickstart/quickstart.md?muiMarkdown';
 
 export default function Page() {
   return <MarkdownDocs {...pageProps} disableAd />;

docs/pages/base-ui/getting-started/support.js

@@ -1,6 +1,6 @@
 import * as React from 'react';
 import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs';
-import * as pageProps from 'docs/data/base/getting-started/support/support.md?@mui/markdown';
+import * as pageProps from 'docs/data/base/getting-started/support/support.md?muiMarkdown';
 
 export default function Page() {
   return <MarkdownDocs {...pageProps} disableAd />;

docs/pages/base-ui/getting-started/usage.js

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
 import AppFrame from 'docs/src/modules/components/AppFrame';
-import * as pageProps from 'docs/data/base/getting-started/usage/usage.md?@mui/markdown';
+import * as pageProps from 'docs/data/base/getting-started/usage/usage.md?muiMarkdown';
 
 export default function Page() {
   return <MarkdownDocs {...pageProps} disableAd />;

docs/pages/base-ui/guides/next-js-app-router.js

@@ -1,6 +1,6 @@
 import * as React from 'react';
 import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs';
-import * as pageProps from 'docs/data/base/guides/next-js-app-router/next-js-app-router.md?@mui/markdown';
+import * as pageProps from 'docs/data/base/guides/next-js-app-router/next-js-app-router.md?muiMarkdown';
 
 export default function Page() {
   return <MarkdownDocs {...pageProps} />;

docs/pages/base-ui/guides/overriding-component-structure.js

@@ -1,6 +1,6 @@
 import * as React from 'react';
 import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs';
-import * as pageProps from 'docs/data/base/guides/overriding-component-structure/overriding-component-structure.md?@mui/markdown';
+import * as pageProps from 'docs/data/base/guides/overriding-component-structure/overriding-component-structure.md?muiMarkdown';
 
 export default function Page() {
   return <MarkdownDocs {...pageProps} />;

docs/pages/base-ui/guides/working-with-tailwind-css.js

@@ -1,6 +1,6 @@
 import * as React from 'react';
 import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs';
-import * as pageProps from 'docs/data/base/guides/working-with-tailwind-css/working-with-tailwind-css.md?@mui/markdown';
+import * as pageProps from 'docs/data/base/guides/working-with-tailwind-css/working-with-tailwind-css.md?muiMarkdown';
 
 export default function Page() {
   return <MarkdownDocs {...pageProps} />;

docs/pages/base-ui/react-accordion/index.js

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
 import AppFrame from 'docs/src/modules/components/AppFrame';
-import * as pageProps from 'docs/data/base/components/accordion/accordion.md?@mui/markdown';
+import * as pageProps from 'docs/data/base/components/accordion/accordion.md?muiMarkdown';
 
 export default function Page(props) {
   const { userLanguage, ...other } = props;

docs/pages/base-ui/react-autocomplete/[docsTab]/index.js

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
 import AppFrame from 'docs/src/modules/components/AppFrame';
-import * as pageProps from 'docs/data/base/components/autocomplete/autocomplete.md?@mui/markdown';
+import * as pageProps from 'docs/data/base/components/autocomplete/autocomplete.md?muiMarkdown';
 import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
 import useAutocompleteApiJsonPageContent from '../../api/use-autocomplete.json';
 

docs/pages/base-ui/react-autocomplete/index.js

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
 import AppFrame from 'docs/src/modules/components/AppFrame';
-import * as pageProps from 'docs/data/base/components/autocomplete/autocomplete.md?@mui/markdown';
+import * as pageProps from 'docs/data/base/components/autocomplete/autocomplete.md?muiMarkdown';
 
 export default function Page(props) {
   const { userLanguage, ...other } = props;

docs/pages/base-ui/react-badge/[docsTab]/index.js

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
 import AppFrame from 'docs/src/modules/components/AppFrame';
-import * as pageProps from 'docs/data/base/components/badge/badge.md?@mui/markdown';
+import * as pageProps from 'docs/data/base/components/badge/badge.md?muiMarkdown';
 import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
 import BadgeApiJsonPageContent from '../../api/badge.json';
 import useBadgeApiJsonPageContent from '../../api/use-badge.json';

docs/pages/base-ui/react-badge/index.js

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
 import AppFrame from 'docs/src/modules/components/AppFrame';
-import * as pageProps from 'docs/data/base/components/badge/badge.md?@mui/markdown';
+import * as pageProps from 'docs/data/base/components/badge/badge.md?muiMarkdown';
 
 export default function Page(props) {
   const { userLanguage, ...other } = props;

docs/pages/base-ui/react-button/[docsTab]/index.js

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
 import AppFrame from 'docs/src/modules/components/AppFrame';
-import * as pageProps from 'docs/data/base/components/button/button.md?@mui/markdown';
+import * as pageProps from 'docs/data/base/components/button/button.md?muiMarkdown';
 import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
 import ButtonApiJsonPageContent from '../../api/button.json';
 import useButtonApiJsonPageContent from '../../api/use-button.json';

docs/pages/base-ui/react-button/index.js

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
 import AppFrame from 'docs/src/modules/components/AppFrame';
-import * as pageProps from 'docs/data/base/components/button/button.md?@mui/markdown';
+import * as pageProps from 'docs/data/base/components/button/button.md?muiMarkdown';
 
 export default function Page(props) {
   const { userLanguage, ...other } = props;

docs/pages/base-ui/react-checkbox/index.js

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
 import AppFrame from 'docs/src/modules/components/AppFrame';
-import * as pageProps from 'docs/data/base/components/checkbox/checkbox.md?@mui/markdown';
+import * as pageProps from 'docs/data/base/components/checkbox/checkbox.md?muiMarkdown';
 
 export default function Page(props) {
   const { userLanguage, ...other } = props;

docs/pages/base-ui/react-click-away-listener/[docsTab]/index.js

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
 import AppFrame from 'docs/src/modules/components/AppFrame';
-import * as pageProps from 'docs/data/base/components/click-away-listener/click-away-listener.md?@mui/markdown';
+import * as pageProps from 'docs/data/base/components/click-away-listener/click-away-listener.md?muiMarkdown';
 import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
 import ClickAwayListenerApiJsonPageContent from '../../api/click-away-listener.json';
 

docs/pages/base-ui/react-click-away-listener/index.js

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
 import AppFrame from 'docs/src/modules/components/AppFrame';
-import * as pageProps from 'docs/data/base/components/click-away-listener/click-away-listener.md?@mui/markdown';
+import * as pageProps from 'docs/data/base/components/click-away-listener/click-away-listener.md?muiMarkdown';
 
 export default function Page(props) {
   const { userLanguage, ...other } = props;

docs/pages/base-ui/react-drawer/index.js

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
 import AppFrame from 'docs/src/modules/components/AppFrame';
-import * as pageProps from 'docs/data/base/components/drawer/drawer.md?@mui/markdown';
+import * as pageProps from 'docs/data/base/components/drawer/drawer.md?muiMarkdown';
 
 export default function Page(props) {
   const { userLanguage, ...other } = props;

docs/pages/base-ui/react-focus-trap/[docsTab]/index.js

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
 import AppFrame from 'docs/src/modules/components/AppFrame';
-import * as pageProps from 'docs/data/base/components/focus-trap/focus-trap.md?@mui/markdown';
+import * as pageProps from 'docs/data/base/components/focus-trap/focus-trap.md?muiMarkdown';
 import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
 import FocusTrapApiJsonPageContent from '../../api/focus-trap.json';
 

docs/pages/base-ui/react-focus-trap/index.js

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
 import AppFrame from 'docs/src/modules/components/AppFrame';
-import * as pageProps from 'docs/data/base/components/focus-trap/focus-trap.md?@mui/markdown';
+import * as pageProps from 'docs/data/base/components/focus-trap/focus-trap.md?muiMarkdown';
 
 export default function Page(props) {
   const { userLanguage, ...other } = props;

docs/pages/base-ui/react-form-control/[docsTab]/index.js

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
 import AppFrame from 'docs/src/modules/components/AppFrame';
-import * as pageProps from 'docs/data/base/components/form-control/form-control.md?@mui/markdown';
+import * as pageProps from 'docs/data/base/components/form-control/form-control.md?muiMarkdown';
 import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
 import FormControlApiJsonPageContent from '../../api/form-control.json';
 import useFormControlContextApiJsonPageContent from '../../api/use-form-control-context.json';

docs/pages/base-ui/react-form-control/index.js

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
 import AppFrame from 'docs/src/modules/components/AppFrame';
-import * as pageProps from 'docs/data/base/components/form-control/form-control.md?@mui/markdown';
+import * as pageProps from 'docs/data/base/components/form-control/form-control.md?muiMarkdown';
 
 export default function Page(props) {
   const { userLanguage, ...other } = props;

docs/pages/base-ui/react-input/[docsTab]/index.js

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
 import AppFrame from 'docs/src/modules/components/AppFrame';
-import * as pageProps from 'docs/data/base/components/input/input.md?@mui/markdown';
+import * as pageProps from 'docs/data/base/components/input/input.md?muiMarkdown';
 import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
 import InputApiJsonPageContent from '../../api/input.json';
 import useInputApiJsonPageContent from '../../api/use-input.json';

docs/pages/base-ui/react-input/index.js

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
 import AppFrame from 'docs/src/modules/components/AppFrame';
-import * as pageProps from 'docs/data/base/components/input/input.md?@mui/markdown';
+import * as pageProps from 'docs/data/base/components/input/input.md?muiMarkdown';
 
 export default function Page(props) {
   const { userLanguage, ...other } = props;

docs/pages/base-ui/react-menu/[docsTab]/index.js

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
 import AppFrame from 'docs/src/modules/components/AppFrame';
-import * as pageProps from 'docs/data/base/components/menu/menu.md?@mui/markdown';
+import * as pageProps from 'docs/data/base/components/menu/menu.md?muiMarkdown';
 import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
 import DropdownApiJsonPageContent from '../../api/dropdown.json';
 import MenuApiJsonPageContent from '../../api/menu.json';

docs/pages/base-ui/react-menu/index.js

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
 import AppFrame from 'docs/src/modules/components/AppFrame';
-import * as pageProps from 'docs/data/base/components/menu/menu.md?@mui/markdown';
+import * as pageProps from 'docs/data/base/components/menu/menu.md?muiMarkdown';
 
 export default function Page(props) {
   const { userLanguage, ...other } = props;

docs/pages/base-ui/react-modal/[docsTab]/index.js

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
 import AppFrame from 'docs/src/modules/components/AppFrame';
-import * as pageProps from 'docs/data/base/components/modal/modal.md?@mui/markdown';
+import * as pageProps from 'docs/data/base/components/modal/modal.md?muiMarkdown';
 import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
 import ModalApiJsonPageContent from '../../api/modal.json';
 import useModalApiJsonPageContent from '../../api/use-modal.json';

docs/pages/base-ui/react-modal/index.js

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
 import AppFrame from 'docs/src/modules/components/AppFrame';
-import * as pageProps from 'docs/data/base/components/modal/modal.md?@mui/markdown';
+import * as pageProps from 'docs/data/base/components/modal/modal.md?muiMarkdown';
 
 export default function Page(props) {
   const { userLanguage, ...other } = props;

docs/pages/base-ui/react-no-ssr/[docsTab]/index.js

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
 import AppFrame from 'docs/src/modules/components/AppFrame';
-import * as pageProps from 'docs/data/base/components/no-ssr/no-ssr.md?@mui/markdown';
+import * as pageProps from 'docs/data/base/components/no-ssr/no-ssr.md?muiMarkdown';
 import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
 import NoSsrApiJsonPageContent from '../../api/no-ssr.json';
 

docs/pages/base-ui/react-no-ssr/index.js

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
 import AppFrame from 'docs/src/modules/components/AppFrame';
-import * as pageProps from 'docs/data/base/components/no-ssr/no-ssr.md?@mui/markdown';
+import * as pageProps from 'docs/data/base/components/no-ssr/no-ssr.md?muiMarkdown';
 
 export default function Page(props) {
   const { userLanguage, ...other } = props;

docs/pages/base-ui/react-number-input/[docsTab]/index.js

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
 import AppFrame from 'docs/src/modules/components/AppFrame';
-import * as pageProps from 'docs/data/base/components/number-input/number-input.md?@mui/markdown';
+import * as pageProps from 'docs/data/base/components/number-input/number-input.md?muiMarkdown';
 import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
 import NumberInputApiJsonPageContent from '../../api/number-input.json';
 import useNumberInputApiJsonPageContent from '../../api/use-number-input.json';