dumi 2.0.0-alpha.2 → 2.0.0-alpha.3

package/dist/client/theme-api/DumiDemoGrid.js

@@ -12,11 +12,11 @@ function _iterableToArrayLimit(arr, i) { var _i = arr == null ? null : typeof Sy
 
 function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
 
-import { useMatchedRouteMeta } from 'dumi/theme';
+import { useRouteMeta } from 'dumi/theme';
 import React, { useState } from 'react';
 import { DumiDemo } from "./DumiDemo";
 export var DumiDemoGrid = function DumiDemoGrid(props) {
-  var meta = useMatchedRouteMeta();
+  var meta = useRouteMeta();
 
   var _useState = useState(function () {
     var _meta$demo;

package/dist/client/theme-api/context.d.ts

@@ -1,10 +1,11 @@
 import { type ComponentType } from 'react';
-import type { ILocalesConfig, IPreviewerProps } from './types';
+import type { ILocalesConfig, IPreviewerProps, IThemeConfig } from './types';
 export interface IThemeContext {
     demos: Record<string, {
         component: ComponentType;
         asset: IPreviewerProps['asset'];
     }>;
-    locales: ILocalesConfig;
+    locales: NonNullable<ILocalesConfig>;
+    themeConfig: IThemeConfig;
 }
 export declare const Context: import("react").Context<IThemeContext>;

package/dist/client/theme-api/context.js

@@ -1,5 +1,6 @@
 import { createContext } from 'react';
 export var Context = /*#__PURE__*/createContext({
   demos: {},
-  locales: []
+  locales: [],
+  themeConfig: {}
 });

package/dist/client/theme-api/index.d.ts

@@ -3,4 +3,6 @@ export * from './context';
 export * from './DumiDemo';
 export * from './DumiDemoGrid';
 export * from './types';
-export * from './useMatchedRouteMeta';
+export * from './useNavData';
+export * from './useRouteMeta';
+export * from './useSidebarData';

package/dist/client/theme-api/index.js

@@ -3,4 +3,6 @@ export * from "./context";
 export * from "./DumiDemo";
 export * from "./DumiDemoGrid";
 export * from "./types";
-export * from "./useMatchedRouteMeta";
+export * from "./useNavData";
+export * from "./useRouteMeta";
+export * from "./useSidebarData";

package/dist/client/theme-api/types.d.ts

@@ -24,10 +24,17 @@ export interface IPreviewerProps {
     [key: string]: any;
 }
 export interface IRouteMeta {
-    title?: string;
+    title: string;
     description?: string;
     keywords?: string[];
-    category?: string;
+    nav?: string | {
+        title?: string;
+        order?: number;
+    };
+    group?: string | {
+        title?: string;
+        order?: number;
+    };
     order?: number;
     toc?: boolean | 'content' | 'menu';
     demo?: {
@@ -40,8 +47,38 @@ declare type IBasicLocale = {
     name: string;
 };
 export declare type ILocalesConfig = ((IBasicLocale & {
-    base?: string;
+    base: string;
 }) | (IBasicLocale & {
     suffix: string;
 }))[];
+export interface INavItem {
+    title: string;
+    link: string;
+    [key: string]: any;
+}
+interface ISidebarItem {
+    title: string;
+    link: string;
+    [key: string]: any;
+}
+export interface ISidebarGroup {
+    title?: string;
+    children: ISidebarItem[];
+    [key: string]: any;
+}
+export interface IThemeConfig {
+    nav?: (INavItem & {
+        children?: INavItem[];
+    })[];
+    sidebar?: Record<string, ISidebarGroup[]>;
+    [key: string]: any;
+}
+export declare type IRoutesById = Record<string, {
+    path?: string;
+    parentId?: string;
+    meta?: IRouteMeta;
+    id: string;
+    redirect?: string;
+    [key: string]: any;
+}>;
 export {};

package/dist/client/theme-api/useNavData.d.ts

@@ -0,0 +1,6 @@
+/**
+ * hook for get nav data
+ */
+export declare const useNavData: () => (import("./types").INavItem & {
+    children?: import("./types").INavItem[] | undefined;
+})[] | undefined;

package/dist/client/theme-api/useNavData.js

@@ -0,0 +1,78 @@
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+
+function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
+
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
+
+function _iterableToArrayLimit(arr, i) { var _i = arr == null ? null : typeof Symbol !== "undefined" && arr[Symbol.iterator] || arr["@@iterator"]; if (_i == null) return; var _arr = []; var _n = true; var _d = false; var _s, _e; try { for (_i = _i.call(arr); !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"] != null) _i["return"](); } finally { if (_d) throw _e; } } return _arr; }
+
+function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
+
+import { Context } from 'dumi/theme';
+import { useContext, useState } from 'react';
+import { useFullSidebarData } from "./useSidebarData";
+import { useLocaleDocRoutes } from "./utils";
+/**
+ * hook for get nav data
+ */
+
+export var useNavData = function useNavData() {
+  var routes = useLocaleDocRoutes();
+
+  var _useContext = useContext(Context),
+      themeConfig = _useContext.themeConfig;
+
+  var sidebar = useFullSidebarData();
+
+  var _useState = useState(function () {
+    // use user config first
+    if (themeConfig.nav) return themeConfig.nav; // fallback to generate nav data from sidebar data
+
+    var data = Object.entries(sidebar).map(function (_ref) {
+      var _ref2 = _slicedToArray(_ref, 2),
+          link = _ref2[0],
+          groups = _ref2[1];
+
+      var meta = Object.values(routes).reduce(function (ret, route) {
+        var _nav$order;
+
+        // find routes which within the nav path
+        if (route.path.startsWith(link.slice(1))) {
+          switch (_typeof(route.meta.nav)) {
+            case 'object':
+              ret.title = route.meta.nav.title || ret.title;
+              ret.order = (_nav$order = route.meta.nav.order) !== null && _nav$order !== void 0 ? _nav$order : ret.order;
+              break;
+
+            case 'string':
+              ret.title = route.meta.nav || ret.title;
+              break;
+
+            default:
+          }
+        }
+
+        return ret;
+      }, {});
+      return {
+        title: meta.title || groups[0].title || groups[0].children[0].title,
+        order: meta.order || 0,
+        link: groups[0].children[0].link
+      };
+    }); // TODO: 2-level nav data
+
+    return data.sort(function (a, b) {
+      var _a$title;
+
+      return a.order - b.order || ((_a$title = a.title) === null || _a$title === void 0 ? void 0 : _a$title.localeCompare(b.title));
+    });
+  }),
+      _useState2 = _slicedToArray(_useState, 1),
+      nav = _useState2[0];
+
+  return nav;
+};

package/dist/client/theme-api/{useMatchedRouteMeta.d.ts → useRouteMeta.d.ts}

@@ -2,4 +2,4 @@ import type { IRouteMeta } from './types';
 /**
  * hook for get matched route meta
  */
-export declare const useMatchedRouteMeta: () => IRouteMeta;
+export declare const useRouteMeta: () => IRouteMeta;

package/dist/client/theme-api/{useMatchedRouteMeta.js → useRouteMeta.js}

@@ -16,7 +16,7 @@ import { useCallback, useEffect, useState } from 'react';
 /**
  * hook for get matched route meta
  */
-export var useMatchedRouteMeta = function useMatchedRouteMeta() {
+export var useRouteMeta = function useRouteMeta() {
   var _useRouteData = useRouteData(),
       route = _useRouteData.route;
 
@@ -29,7 +29,7 @@ export var useMatchedRouteMeta = function useMatchedRouteMeta() {
   var getter = useCallback(function () {
     var ret;
 
-    if (route.path === pathname) {
+    if (route.path === pathname && !('isLayout' in route)) {
       // use `useRouteData` result if matched, for performance
       ret = route.meta;
     } else {

package/dist/client/theme-api/useSidebarData.d.ts

@@ -0,0 +1,8 @@
+/**
+ * hook for get sidebar data for all nav
+ */
+export declare const useFullSidebarData: () => any;
+/**
+ * hook for get sidebar data for current nav
+ */
+export declare const useSidebarData: () => any;

package/dist/client/theme-api/useSidebarData.js

@@ -0,0 +1,132 @@
+function _toConsumableArray(arr) { return _arrayWithoutHoles(arr) || _iterableToArray(arr) || _unsupportedIterableToArray(arr) || _nonIterableSpread(); }
+
+function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+
+function _iterableToArray(iter) { if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter); }
+
+function _arrayWithoutHoles(arr) { if (Array.isArray(arr)) return _arrayLikeToArray(arr); }
+
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+
+function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
+
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
+
+function _iterableToArrayLimit(arr, i) { var _i = arr == null ? null : typeof Symbol !== "undefined" && arr[Symbol.iterator] || arr["@@iterator"]; if (_i == null) return; var _arr = []; var _n = true; var _d = false; var _s, _e; try { for (_i = _i.call(arr); !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"] != null) _i["return"](); } finally { if (_d) throw _e; } } return _arr; }
+
+function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
+
+import { useLocation } from 'dumi';
+import { Context } from 'dumi/theme';
+import { useContext, useState } from 'react';
+import { useLocale, useLocaleDocRoutes } from "./utils";
+var DEFAULT_GROUP_STUB_TITLE = '$default-group-title';
+
+var getLocaleClearPath = function getLocaleClearPath(routePath, locale) {
+  return 'base' in locale ? routePath.replace(locale.base.slice(1), '').replace(/^\//, '') : routePath;
+};
+/**
+ * hook for get sidebar data for all nav
+ */
+
+
+export var useFullSidebarData = function useFullSidebarData() {
+  var locale = useLocale();
+  var routes = useLocaleDocRoutes();
+
+  var _useContext = useContext(Context),
+      themeConfig = _useContext.themeConfig;
+
+  var _useState = useState(function () {
+    // auto generate sidebar data from routes
+    var data = Object.values(routes).reduce(function (ret, route) {
+      var clearPath = getLocaleClearPath(route.path, locale); // skip index routes
+
+      if (clearPath) {
+        var _ret$parentPath, _ret$parentPath$title, _ret$parentPath$title2;
+
+        // extract parent path from route path
+        // a => /a
+        // en-US/a => /en-US/a
+        // a/b => /a
+        // en-US/a/b => /en-US/a
+        var parentPath = "/".concat(route.path.replace(/\/[^/]+$/, ''));
+
+        var _ref = _typeof(route.meta.group) === 'object' ? route.meta.group : {
+          title: route.meta.group
+        },
+            title = _ref.title,
+            _ref$order = _ref.order,
+            order = _ref$order === void 0 ? 0 : _ref$order;
+
+        var titleKey = title || DEFAULT_GROUP_STUB_TITLE; // create group data by nav path & group name
+
+        (_ret$parentPath = ret[parentPath]) !== null && _ret$parentPath !== void 0 ? _ret$parentPath : ret[parentPath] = {};
+        ret[parentPath][titleKey] = {
+          title: title,
+          order: ((_ret$parentPath$title = ret[parentPath][titleKey]) === null || _ret$parentPath$title === void 0 ? void 0 : _ret$parentPath$title.order) || order,
+          children: [].concat(_toConsumableArray(((_ret$parentPath$title2 = ret[parentPath][titleKey]) === null || _ret$parentPath$title2 === void 0 ? void 0 : _ret$parentPath$title2.children) || []), [{
+            title: route.meta.title,
+            link: "/".concat(route.path),
+            order: route.meta.order || 0
+          }])
+        };
+      }
+
+      return ret;
+    }, {}); // destruct sidebar data into sidebar config
+
+    var sidebarConfig = Object.entries(data).reduce(function (ret, _ref2) {
+      var _ref3 = _slicedToArray(_ref2, 2),
+          navPath = _ref3[0],
+          groups = _ref3[1];
+
+      ret[navPath] = Object.values(groups).sort(function (a, b) {
+        var _a$title;
+
+        return (// sort by group order
+          a.order - b.order || (a.title ? // sort by group title
+          (_a$title = a.title) === null || _a$title === void 0 ? void 0 : _a$title.localeCompare(b.title || '') : // put non-title group at the end
+          -1)
+        );
+      }); // sort group children by order or title
+
+      ret[navPath].forEach(function (group) {
+        return group.children.sort(function (a, b) {
+          return a.order - b.order || a.title.localeCompare(b.title);
+        });
+      });
+      return ret;
+    }, {}); // allow user partial override
+
+    return Object.assign(sidebarConfig, themeConfig.sidebar);
+  }),
+      _useState2 = _slicedToArray(_useState, 1),
+      sidebar = _useState2[0];
+
+  return sidebar;
+};
+/**
+ * hook for get sidebar data for current nav
+ */
+
+export var useSidebarData = function useSidebarData() {
+  var locale = useLocale();
+  var sidebar = useFullSidebarData();
+
+  var _useLocation = useLocation(),
+      pathname = _useLocation.pathname;
+
+  var clearPath = getLocaleClearPath(pathname.slice(1), locale); // extract parent path from location pathname
+  // /a => /a
+  // /a/b => /a
+  // /en-US/a => /en-US/a
+  // /en-US/a/b => /en-US/a
+
+  var parentPath = clearPath ? pathname.replace(/(\/[^/]+)(\/[^/]+)$/, '$1') : pathname;
+  return parentPath ? sidebar[parentPath] : [];
+};

package/dist/client/theme-api/utils.d.ts

@@ -0,0 +1,3 @@
+import type { IRoutesById } from './types';
+export declare const useLocale: () => any;
+export declare const useLocaleDocRoutes: () => IRoutesById;

package/dist/client/theme-api/utils.js

@@ -0,0 +1,62 @@
+function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
+
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
+
+function _iterableToArrayLimit(arr, i) { var _i = arr == null ? null : typeof Symbol !== "undefined" && arr[Symbol.iterator] || arr["@@iterator"]; if (_i == null) return; var _arr = []; var _n = true; var _d = false; var _s, _e; try { for (_i = _i.call(arr); !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"] != null) _i["return"](); } finally { if (_d) throw _e; } } return _arr; }
+
+function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
+
+import { useAppData } from 'dumi';
+import { Context, useIntl } from 'dumi/theme';
+import { useContext, useState } from 'react';
+export var useLocale = function useLocale() {
+  var intl = useIntl();
+
+  var _useContext = useContext(Context),
+      locales = _useContext.locales;
+
+  var _useState = useState(function () {
+    return locales.find(function (_ref) {
+      var id = _ref.id;
+      return id === intl.locale;
+    });
+  }),
+      _useState2 = _slicedToArray(_useState, 1),
+      locale = _useState2[0];
+
+  return locale;
+};
+export var useLocaleDocRoutes = function useLocaleDocRoutes() {
+  var intl = useIntl();
+
+  var _useAppData = useAppData(),
+      routes = _useAppData.routes;
+
+  var _useContext2 = useContext(Context),
+      locales = _useContext2.locales;
+
+  var _useState3 = useState(function () {
+    var reversedLocales = locales.slice().reverse();
+    return Object.values(routes).reduce(function (ret, route) {
+      var matched = reversedLocales.find(function (locale) {
+        return 'suffix' in locale ? // suffix mode
+        route.path.endsWith(locale.suffix) : // base mode
+        route.path.startsWith(locale.base.slice(1));
+      });
+
+      if (route.parentId === 'DocLayout' && matched.id === intl.locale) {
+        ret[route.id] = route;
+      }
+
+      return ret;
+    }, {});
+  }),
+      _useState4 = _slicedToArray(_useState3, 1),
+      localeDocRoutes = _useState4[0];
+
+  return localeDocRoutes;
+};

package/dist/features/configPlugins/index.js

@@ -29,7 +29,8 @@ var configPlugins_default = (api) => {
       docDirs: ["docs"],
       entityDirs: [{ type: "component", dir: "src" }],
       codeBlockMode: "active"
-    }
+    },
+    themeConfig: {}
   };
   const schemas = (0, import_schema.getSchemas)();
   for (const key of Object.keys(schemas)) {

package/dist/features/configPlugins/schema.js

@@ -33,7 +33,11 @@ function getSchemas() {
       codeBlockMode: Joi.string().valid("active", "passive").optional()
     }).optional(),
     extraRemarkPlugins: getUnifiedPluginSchema,
-    extraRehypePlugins: getUnifiedPluginSchema
+    extraRehypePlugins: getUnifiedPluginSchema,
+    themeConfig: (Joi) => Joi.object({
+      nav: Joi.array().items(Joi.object()).optional(),
+      sidebar: Joi.object().optional()
+    }).optional()
   };
 }
 // Annotate the CommonJS export names for ESM import in node:

package/dist/features/locales.js

@@ -23,9 +23,16 @@ __export(locales_exports, {
 });
 module.exports = __toCommonJS(locales_exports);
 var locales_default = (api) => {
+  var _a;
   api.describe({
     config: {
-      default: [{ id: "zh-CN", name: "\u4E2D\u6587", base: "/" }],
+      default: [
+        {
+          id: "zh-CN",
+          name: "\u4E2D\u6587",
+          ...((_a = api.userConfig.locales) == null ? void 0 : _a[0]) && "suffix" in api.userConfig.locales[0] ? {} : { base: "/" }
+        }
+      ],
       schema: (Joi) => {
         const basicOpts = { id: Joi.string(), name: Joi.string() };
         return Joi.alternatives(Joi.array().items(Joi.object({
@@ -42,8 +49,8 @@ var locales_default = (api) => {
     key: "modifyConfig",
     stage: Infinity,
     fn: (memo) => {
-      var _a;
-      (_a = memo.locales) == null ? void 0 : _a.forEach((locale, i) => {
+      var _a2;
+      (_a2 = memo.locales) == null ? void 0 : _a2.forEach((locale, i) => {
         if (!("suffix" in locale)) {
           locale.base ?? (locale.base = i ? `/${locale.id}` : "/");
         }
@@ -71,11 +78,12 @@ const cache = createIntlCache();
 
 const LocalesContainer: FC<{ children: ReactNode }> = (props) => {
   const [locale] = useState(() => {
-    const matched = locales.find((locale) => (
-      // base mode
-      history.location.pathname.startsWith(locale.base) ||
-      // suffix mode
-      ('suffix' in locale && history.location.pathname.endsWith(locale.suffix))
+    const matched = locales.slice().reverse().find((locale) => (
+      'suffix' in locale
+        // suffix mode
+        ? history.location.pathname.endsWith(locale.suffix)
+        // base mode
+        : history.location.pathname.startsWith(locale.base)
     ));
 
     return matched ? matched.id : locales[0].id;

package/dist/features/routes.js

@@ -36,7 +36,7 @@ function localizeUmiRoute(route, locales) {
   if (locale) {
     const base = !("base" in locale) || locale.base === "/" ? "" : locale.base.replace(/^(\/)(.+)$/, "$2$1");
     const suffix = "suffix" in locale ? locale.suffix : "";
-    route.path = `${base}${route.path.replace(new RegExp(`/${locale.id}$`), "").replace(/(\/index|\/README)$/, "")}${suffix}`;
+    route.path = `${base}${route.path.replace(new RegExp(`/${locale.id}$`), "").replace(/((^|\/)(index|README))$/, "")}${suffix}`;
     route.absPath = route.path !== "/" ? `/${route.path}` : route.path;
   }
 }

package/dist/features/theme/index.js

@@ -115,7 +115,7 @@ export default function DumiContextWrapper() {
   const outlet = useOutlet();
 
   return (
-    <Context.Provider value={{ demos, locales }}>{outlet}</Context.Provider>
+    <Context.Provider value={{ demos, locales, themeConfig: ${JSON.stringify(api.config.themeConfig)} }}>{outlet}</Context.Provider>
   );
 }`
     });

package/dist/index.d.ts

@@ -1,8 +1,8 @@
-import type { IDumiConfig } from "./types";
+import type { IDumiUserConfig } from "./types";
 declare let unistUtilVisit: typeof import('unist-util-visit');
 export { IApi } from "./types";
 export type { Root as HastRoot } from 'hast';
 export * from 'umi';
 export type { Plugin as UnifiedPlugin, Transformer as UnifiedTransformer, } from 'unified';
 export { unistUtilVisit };
-export declare const defineConfig: (config: IDumiConfig) => IDumiConfig;
+export declare const defineConfig: (config: IDumiUserConfig) => IDumiUserConfig;

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-import type { IDumiDemoProps, ILocalesConfig } from "./client/theme-api";
+import type { IDumiDemoProps, ILocalesConfig, IThemeConfig } from "./client/theme-api";
 import type { IThemeLoadResult } from "./features/theme/loader";
 import type { IModify } from '@umijs/core';
 import type { ExampleBlockAsset } from 'dumi-assets-types';
@@ -15,12 +15,17 @@ export interface IDumiConfig extends IUmiConfig {
         codeBlockMode: 'active' | 'passive';
     };
     locales: ILocalesConfig;
+    themeConfig: IThemeConfig;
     /**
      * extra unified plugins
      */
     extraRemarkPlugins?: (string | Function | [string | Function, object])[];
     extraRehypePlugins?: (string | Function | [string | Function, object])[];
 }
+export interface IDumiUserConfig extends Partial<Omit<IDumiConfig, 'resolve' | 'locales'>> {
+    resolve?: Partial<IDumiConfig['resolve']>;
+    locales?: (IDumiConfig['locales'][0] | Omit<IDumiConfig['locales'][0], 'base'>)[];
+}
 export declare abstract class IDumiTechStack {
     /**
      * tech stack name, such as 'react'
@@ -53,7 +58,7 @@ export declare abstract class IDumiTechStack {
 }
 export declare type IApi = IUmiApi & {
     config: IDumiConfig;
-    userConfig: IDumiConfig;
+    userConfig: IDumiUserConfig;
     service: IUmiApi['service'] & {
         themeData: IThemeLoadResult;
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dumi",
-  "version": "2.0.0-alpha.2",
+  "version": "2.0.0-alpha.3",
   "description": "Framework for developing UI components",
   "keywords": [],
   "license": "MIT",
@@ -63,6 +63,7 @@
     "mdast-util-to-string": "^3.1.0",
     "pluralize": "^8.0.0",
     "raw-loader": "^4.0.2",
+    "react-helmet": "^6.1.0",
     "react-intl": "^6.1.1",
     "rehype-stringify": "^9.0.3",
     "remark-breaks": "^3.0.2",
@@ -86,6 +87,7 @@
     "@types/node": "^18.6.3",
     "@types/pluralize": "^0.0.29",
     "@types/react": "^18.0.16",
+    "@types/react-helmet": "^6.1.5",
     "@umijs/lint": "^4.0.22",
     "@umijs/test": "^4.0.22",
     "cross-env": "^7.0.3",

package/theme-default/layouts/DocLayout/index.js

@@ -1,12 +1,33 @@
 import { useOutlet } from 'dumi';
+import { useIntl, useRouteMeta } from 'dumi/theme';
 import Content from 'dumi/theme/slots/Content';
 import Header from 'dumi/theme/slots/Header';
 import Sidebar from 'dumi/theme/slots/Sidebar';
 import React from 'react';
+import Helmet from 'react-helmet';
 
 var DocLayout = function DocLayout() {
+  var intl = useIntl();
   var outlet = useOutlet();
-  return /*#__PURE__*/React.createElement("div", null, /*#__PURE__*/React.createElement(Header, null), /*#__PURE__*/React.createElement("main", {
+  var meta = useRouteMeta();
+  return /*#__PURE__*/React.createElement("div", null, /*#__PURE__*/React.createElement(Helmet, null, /*#__PURE__*/React.createElement("html", {
+    lang: intl.locale.replace(/-.+$/, '')
+  }), meta.title && /*#__PURE__*/React.createElement("title", null, meta.title), meta.title && /*#__PURE__*/React.createElement("meta", {
+    property: "og:title",
+    content: meta.title
+  }), meta.description && /*#__PURE__*/React.createElement("meta", {
+    name: "description",
+    content: meta.description
+  }), meta.description && /*#__PURE__*/React.createElement("meta", {
+    property: "og:description",
+    content: meta.description
+  }), meta.keywords && /*#__PURE__*/React.createElement("meta", {
+    name: "keywords",
+    content: meta.keywords.join(',')
+  }), meta.keywords && /*#__PURE__*/React.createElement("meta", {
+    property: "og:keywords",
+    content: meta.keywords.join(',')
+  })), /*#__PURE__*/React.createElement(Header, null), /*#__PURE__*/React.createElement("main", {
     style: {
       display: 'flex'
     }