Docs config

Author: Janpot

docs/config.d.ts

@@ -1,7 +1 @@
-export const LANGUAGES: string[];
-
-export const LANGUAGES_SSR: string[];
-
-export const LANGUAGES_IN_PROGRESS: string[];
-
-export const LANGUAGES_IGNORE_PAGES: (pathname: string) => boolean;
+export * from '@mui/docs/config';

docs/config.js

@@ -1,29 +1 @@
-// Valid languages to server-side render in production
-const LANGUAGES = ['en'];
-
-// Server side rendered languages
-const LANGUAGES_SSR = ['en'];
-
-// Work in progress
-const LANGUAGES_IN_PROGRESS = LANGUAGES.slice();
-
-const LANGUAGES_IGNORE_PAGES = (pathname) => {
-  // We don't have the bandwidth like Qt to translate our blog posts
-  // https://www.qt.io/zh-cn/blog
-  if (pathname === '/blog' || pathname.startsWith('/blog/')) {
-    return true;
-  }
-
-  if (pathname === '/size-snapshot/') {
-    return true;
-  }
-
-  return false;
-};
-
-module.exports = {
-  LANGUAGES,
-  LANGUAGES_IN_PROGRESS,
-  LANGUAGES_SSR,
-  LANGUAGES_IGNORE_PAGES,
-};
+module.exports = require('@mui/docs/config');

docs/src/modules/components/AppSearch.js

@@ -22,7 +22,7 @@ import NewspaperRoundedIcon from '@mui/icons-material/NewspaperRounded';
 import GlobalStyles from '@mui/material/GlobalStyles';
 import { alpha, styled } from '@mui/material/styles';
 import { pathnameToLanguage } from 'docs/src/modules/utils/helpers';
-import { LANGUAGES_SSR } from 'docs/config';
+import { LANGUAGES_SSR } from '@mui/docs/config';
 import Link from 'docs/src/modules/components/Link';
 import { useTranslate, useUserLanguage } from '@mui/docs/i18n';
 import useLazyCSS from 'docs/src/modules/utils/useLazyCSS';

docs/src/modules/components/Head.tsx

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import NextHead from 'next/head';
 import { useRouter } from 'next/router';
-import { LANGUAGES_SSR } from 'docs/config';
+import { LANGUAGES_SSR } from '@mui/docs/config';
 import { useUserLanguage, useTranslate } from '@mui/docs/i18n';
 import { pathnameToLanguage } from 'docs/src/modules/utils/helpers';
 

docs/src/modules/utils/helpers.ts

@@ -1,6 +1,6 @@
 import upperFirst from 'lodash/upperFirst';
 import camelCase from 'lodash/camelCase';
-import { LANGUAGES } from 'docs/config';
+import { LANGUAGES } from '@mui/docs/config';
 
 function pascalCase(str: string) {
   return upperFirst(camelCase(str));

packages/api-docs-builder-core/baseUi/projectSettings.ts

@@ -1,5 +1,5 @@
 import path from 'path';
-import { LANGUAGES } from 'docs/config';
+import { LANGUAGES } from '@mui/docs/config';
 import { ProjectSettings } from '@mui-internal/api-docs-builder';
 import findApiPages from '@mui-internal/api-docs-builder/utils/findApiPages';
 import {

packages/api-docs-builder-core/joyUi/projectSettings.ts

@@ -1,5 +1,5 @@
 import path from 'path';
-import { LANGUAGES } from 'docs/config';
+import { LANGUAGES } from '@mui/docs/config';
 import { ProjectSettings } from '@mui-internal/api-docs-builder';
 import findApiPages from '@mui-internal/api-docs-builder/utils/findApiPages';
 import {

packages/api-docs-builder-core/materialUi/projectSettings.ts

@@ -1,5 +1,5 @@
 import path from 'path';
-import { LANGUAGES } from 'docs/config';
+import { LANGUAGES } from '@mui/docs/config';
 import { ProjectSettings } from '@mui-internal/api-docs-builder';
 import findApiPages from '@mui-internal/api-docs-builder/utils/findApiPages';
 import {

packages/api-docs-builder-core/muiSystem/projectSettings.ts

@@ -1,5 +1,5 @@
 import path from 'path';
-import { LANGUAGES } from 'docs/config';
+import { LANGUAGES } from '@mui/docs/config';
 import { ProjectSettings } from '@mui-internal/api-docs-builder';
 import findApiPages from '@mui-internal/api-docs-builder/utils/findApiPages';
 import {

packages/api-docs-builder-core/package.json

@@ -9,6 +9,7 @@
     "typescript": "tsc -p tsconfig.json"
   },
   "dependencies": {
+    "@mui/docs": "workspace:^",
     "@mui-internal/api-docs-builder": "workspace:^",
     "@mui/markdown": "workspace:^",
     "docs": "workspace:^",

packages/mui-docs/src/config/index.d.ts

@@ -0,0 +1,7 @@
+export const LANGUAGES: string[];
+
+export const LANGUAGES_SSR: string[];
+
+export const LANGUAGES_IN_PROGRESS: string[];
+
+export const LANGUAGES_IGNORE_PAGES: (pathname: string) => boolean;

packages/mui-docs/src/config/index.js

@@ -0,0 +1,29 @@
+// Valid languages to server-side render in production
+const LANGUAGES = ['en'];
+
+// Server side rendered languages
+const LANGUAGES_SSR = ['en'];
+
+// Work in progress
+const LANGUAGES_IN_PROGRESS = LANGUAGES.slice();
+
+const LANGUAGES_IGNORE_PAGES = (pathname) => {
+  // We don't have the bandwidth like Qt to translate our blog posts
+  // https://www.qt.io/zh-cn/blog
+  if (pathname === '/blog' || pathname.startsWith('/blog/')) {
+    return true;
+  }
+
+  if (pathname === '/size-snapshot/') {
+    return true;
+  }
+
+  return false;
+};
+
+module.exports = {
+  LANGUAGES,
+  LANGUAGES_IN_PROGRESS,
+  LANGUAGES_SSR,
+  LANGUAGES_IGNORE_PAGES,
+};