dumi

定制主题修改

https://github.com/umijs/dumi/tree/master/suites/theme-mobile/src/builtins/Previewer

• 在 .dumi/theme/builtins目录自定义主题修改

  • 可动态修改demoUrl
    • 参考： https://juejin.cn/post/7071909224598470687#heading-3

自动 API 表格

• 1、首先在 .dumirc.ts 中打开 apiParser 的配置项，并配置 entryFile 的路径：

• 2、然后在入口文件中导出组件模块，可以直接 export

• 3、最后在 Markdown 文件中使用 API 组件即可：

  • text

    <API id="Foo"></API>

js

// src/index.tsx
import React, { type FC } from 'react';

export const Foo: FC<{
  /**
   * @description 属性描述
   * @default "默认值"
   */
  title?: string;
}> = ({ title }) => <h1>{title}</h1>;

移动端配置

taro端：

需要的配置项

• demoUrl
  • 用于指定该 demo 的访问链接，仅在 iframe 呈现模式下才会生效；通常在 dumi 默认渲染的 demo 无法满足展示需要时使用，例如需要呈现 ReactNative 的渲染结果。
• iframe
  • 使用 iframe 形式渲染 demo，通常用于 Layout 等需要与页面隔离的 demo。

YAML front matter

front matter 必须是 markdown 文件中的第一部分，并且必须采用在三点划线之间书写的有效的 YAML