dumi 2.0.6 → 2.0.8

package/README.md

@@ -1,18 +1,29 @@
 # dumi
 
-[![NPM version](https://img.shields.io/npm/v/dumi/next)](https://npmjs.org/package/dumi) [![NPM downloads](https://img.shields.io/npm/dm/dumi)](https://npmjs.org/package/dumi)
+[![NPM version](https://img.shields.io/npm/v/dumi)](https://npmjs.org/package/dumi) [![NPM downloads](https://img.shields.io/npm/dm/dumi)](https://npmjs.org/package/dumi) [![GitHub CI](https://github.com/umijs/dumi/workflows/CI/badge.svg)](https://github.com/umijs/dumi)
 
-The development version for dumi 2, if you are looking for dumi 1, please switch to the [1.x branch](https://github.com/umijs/dumi/tree/1.x).
+<img src="https://gw.alipayobjects.com/zos/bmw-prod/d3e3eb39-1cd7-4aa5-827c-877deced6b7e/lalxt4g3_w256_h256.png" width="120">
 
-## Install
+dumi is a static site generator for component library development.
+
+## Usage & Guide
+
+To view more online examples and docs, please visit [dumi official site](https://d.umijs.org).
+
+## Development
 
 ```bash
 $ pnpm install
+$ pnpm dev
+$ pnpm docs:dev
 ```
 
-```bash
-$ npm run dev
-$ npm run build
+## Badge
+
+Using dumi? Add a README badge to show it off: [![dumi](https://img.shields.io/badge/docs%20by-dumi-blue)](https://github.com/umijs/dumi)
+
+```
+[![dumi](https://img.shields.io/badge/docs%20by-dumi-blue)](https://github.com/umijs/dumi)
 ```
 
 ## LICENSE

package/dist/assetParsers/atom.d.ts

@@ -18,5 +18,6 @@ declare class AtomAssetsParser {
         functions: Record<string, AtomFunctionAsset>;
     }>;
     watch(cb: AtomAssetsParser['cbs'][number]): void;
+    unwatch(cb: AtomAssetsParser['cbs'][number]): void;
 }
 export default AtomAssetsParser;

package/dist/assetParsers/atom.js

@@ -45,7 +45,7 @@ var AtomAssetsParser = class {
   async parse() {
     if (!this.resolverDeferrer || this.unresolvedFiles.length) {
       this.resolverDeferrer = (async () => {
-        await this.parser.patch(this.unresolvedFiles);
+        await this.parser.patch(this.unresolvedFiles.splice(0));
         return new import_parser.SchemaResolver(await this.parser.parse());
       })();
     }
@@ -106,6 +106,9 @@ var AtomAssetsParser = class {
       });
     }
   }
+  unwatch(cb) {
+    this.cbs.splice(this.cbs.indexOf(cb), 1);
+  }
 };
 var atom_default = AtomAssetsParser;
 // Annotate the CommonJS export names for ESM import in node:

package/dist/features/assets.js

@@ -43,30 +43,49 @@ function addAtomMeta(atomId, data) {
   atomsMeta[atomId] = import_plugin_utils.lodash.pick(data, ["title", "keywords", "deprecated"]);
 }
 var assets_default = (api) => {
+  let compileDeferrer = new Promise((resolve) => {
+    api.register({
+      key: "onDevCompileDone",
+      stage: -Infinity,
+      fn: resolve
+    });
+    api.register({
+      key: "onCompileDone",
+      stage: -Infinity,
+      fn: resolve
+    });
+  });
   api.describe({
     config: {
       schema: (Joi) => Joi.object()
     },
-    enableBy: ({ env }) => env === "production" && Boolean(api.args.assets)
+    enableBy: ({ env }) => env === "development" || Boolean(api.args.assets)
   });
-  api.onBuildComplete(async () => {
-    const { components } = api.service.atomParser ? await api.service.atomParser.parse() : { components: {} };
-    const assets = await api.applyPlugins({
-      key: "modifyAssetsMetadata",
-      initialValue: {
-        name: api.config.themeConfig.title || api.pkg.name,
-        npmPackageName: api.pkg.name,
-        version: api.pkg.version,
-        description: api.pkg.description,
-        logo: api.config.themeConfig.logo,
-        homepage: api.pkg.homepage,
-        repository: api.pkg.repository,
-        assets: {
-          atoms: Object.values(components).map((atom) => Object.assign(atom, atomsMeta[atom.id] || {})),
-          examples: import_plugin_utils.lodash.uniqBy(examples, "id")
+  api.registerMethod({
+    name: "getAssetsMetadata",
+    async fn() {
+      await compileDeferrer;
+      const { components } = api.service.atomParser ? await api.service.atomParser.parse() : { components: {} };
+      return await api.applyPlugins({
+        key: "modifyAssetsMetadata",
+        initialValue: {
+          name: api.config.themeConfig.title || api.pkg.name,
+          npmPackageName: api.pkg.name,
+          version: api.pkg.version,
+          description: api.pkg.description,
+          logo: api.config.themeConfig.logo,
+          homepage: api.pkg.homepage,
+          repository: api.pkg.repository,
+          assets: {
+            atoms: Object.values(components).map((atom) => Object.assign(atom, atomsMeta[atom.id] || {})),
+            examples: import_plugin_utils.lodash.uniqBy(examples, "id")
+          }
         }
-      }
-    });
+      });
+    }
+  });
+  api.onBuildComplete(async () => {
+    const assets = await api.getAssetsMetadata();
     import_fs.default.writeFileSync(import_path.default.join(api.cwd, "assets.json"), JSON.stringify(assets, null, 2), "utf-8");
   });
 };

package/dist/features/derivative.js

@@ -80,7 +80,10 @@ var derivative_default = (api) => {
       import_plugin_utils.logger.warn("Hash history is temporarily incompatible, it is recommended to use browser history for now.");
     }
   });
-  safeExcludeInMFSU(api, [new RegExp("dumi/dist/client")]);
+  safeExcludeInMFSU(api, [
+    new RegExp("dumi/dist/client"),
+    new RegExp("compiled/_internal/searchWorker")
+  ]);
   api.modifyDefaultConfig((memo) => {
     if (api.userConfig.mfsu !== false) {
       if (import_fs.default.existsSync(import_path.default.join(api.cwd, "node_modules", ".pnpm")) || process.platform === "win32") {

package/dist/types.d.ts

@@ -94,5 +94,9 @@ export declare type IApi = IUmiApi & {
      * modify assets metadata
      */
     modifyAssetsMetadata: IModify<AssetsPackage, null>;
+    /**
+     * get assets metadata
+     */
+    getAssetsMetadata?: () => Promise<AssetsPackage>;
 };
 export {};

package/dist/utils.js

@@ -98,7 +98,8 @@ async function tryFatherBuildConfigs(cwd) {
     configs = getBuildConfig(svc.config, svc.pkg);
   } catch {
   }
-  process.env.APP_ROOT = APP_ROOT;
+  if (APP_ROOT)
+    process.env.APP_ROOT = APP_ROOT;
   return configs;
 }
 // Annotate the CommonJS export names for ESM import in node:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dumi",
-  "version": "2.0.6",
+  "version": "2.0.8",
   "description": "📖 Documentation Generator of React Component",
   "keywords": [
     "generator",

package/theme-default/slots/Header/index.less

@@ -43,6 +43,13 @@
     &-aside {
       display: flex;
       align-items: center;
+
+      @media @mobile {
+        margin: 8px 16px;
+        padding-top: 24px;
+        justify-content: center;
+        border-top: 1px solid @c-border-light;
+      }
     }
 
     @media @mobile {
@@ -69,7 +76,7 @@
   &-menu-btn {
     position: absolute;
     top: 50%;
-    right: 24px;
+    inset-inline-end: 24px;
     padding: 0;
     border: 0;
     background: transparent;

package/theme-default/slots/RtlSwitch/index.less

@@ -1,7 +1,7 @@
 @import '../LangSwitch/index.less';
 
 .@{prefix}-lang-switch {
-  + & {
+  & + & {
     margin-inline-start: 20px;
   }
 }

package/theme-default/slots/Toc/index.js

@@ -19,7 +19,8 @@ import "./index.less";
 
 var Toc = function Toc() {
   var _useLocation = useLocation(),
-      pathname = _useLocation.pathname;
+      pathname = _useLocation.pathname,
+      search = _useLocation.search;
 
   var meta = useRouteMeta();
 
@@ -50,7 +51,7 @@ var Toc = function Toc() {
       });
       setSectionRefs(refs);
     }
-  }, [pathname, loading]);
+  }, [pathname, search, loading]);
   return sectionRefs.length ? /*#__PURE__*/React.createElement(ScrollSpy, {
     sectionRefs: sectionRefs
   }, function (_ref3) {