dumi

随着业务的扩展和公司品牌的重视,我们会发现越来越多的业务需要重新整合,这时候需要我们提供一些底层的能力来支撑未来更复杂的设计,和优化我们的产研结构、工作方向。

打造底层能力重要的一项就是组件库的搭建,如果我们业务多元化,每一个方向都需要一个项目来承接,我们需要重复配置初始化不同的项目,这显然会额外增加不少的开发时间,为节省成本我们可能会想到有没有一个开箱即用的库可以解决这一系列的问题?

答案无疑是肯定的,这件事情也有人早就想到了。

下面,我们来一起关注下,究竟是什么库可以解决我们的这个问题:

dumi

什么是 dumi?

dumi 是基于 Umi 打造、为组件开发场景而生的文档工具。

也就是说,dumi 是可以用来写文档、官网和组件库 Demo 的 Umi

有什么功能呢?

  • 可以与 umi 项目集成

  • 丰富的文档编写语法

  • 约定式路由

  • 移动端组件 demo 示例

  • 可自定义主题

dumi 是怎么使用的呢?

初始化
  • 首先需要有 node,且 node 版本是 10.13 或以上。

  • 其次新建文件夹,用来安装 dumi

mkdir myapp && cd myapp
安装
  • 现在,我们来初始化一个文档模式的组件库开发脚手架:
npx @umijs/create-dumi-lib     

或者使用 yarn

yarn create @umijs/dumi-lib
  • 我们再来尝试初始化一个站点模式的组件库开发脚手架:
npx @umijs/create-dumi-lib --site 

或者使用 yarn

yarn create @umijs/dumi-lib --site
  • 我们也可以初始化一个静态站点的脚手架,即一个多语言的站点模式脚手架,仅包含文档。
npx @umijs/create-dumi-app

或者使用 yarn

yarn create @umijs/dumi-app
调试及构建
  • 我们可以使用如下命令开始调试组件或编写文档:
npm run dev 或 npx dumi dev
  • 最后使用如下命令构建及部署:
npm run build 或 npx dumi build

构建默认会输出到 dist 目录下,我们可以将 dist 目录部署在 now.sh、GitHub Pages 等静态站点托管平台或者某台服务器上。

现在我们搭建一个组件项目看看吧

使用命令创建可以发现如下:

初始化项目

从上述图片中,我们可以发现项目中已经包含了测试文件,从此,我们可以快乐地开发组件和 UT 了。

注意:目前文档只支持 md 格式。

安装好依赖运行下项目:

运行项目

现在我们已经可以正常的调试了。

我们在 src 目录下新建个文件夹 test 及内部含有 3 个文件,分别是:index.md、index.test.tsx、index.tsx。

新建文件夹 test

现在已经建好了文件,我们还需要在入口文件 index.tsx 导出新建的文件。

导出新建文件

我们运行下项目:

运行项目

当我们有需求想展示源代码的时候,可以使用 pure 修饰符告诉 dumi

```tsx | pure
import React from 'react';
import { Test } from 'dumi-app';

export default () => <Test title="First Demo" />;

如果示例代码有很多写在这里也会很不方便,这时我们可以引入外部文件:

<code src="/src/demo.tsx"></code>

如果我们需要定位,也请放心使用,我们不会飞出去,只需设置 transformtrue

```tsx | transform
import React from 'react';

export default () => <h1 style={{ position: 'fixed', top: 0, left: 0 }}>我不会飞出去</h1>;
fixed 定位

如果想嵌入到文档,可以使用 inline

```jsx
/**
 * inline: true
 */

import React from 'react';

export default () => '我会被直接嵌入';
嵌入文档

如果需要以 iframe 的形式展示的话,可以设置 iframetrue

```jsx | iframe
import React from 'react';

export default () => (
  <h2 style={{ boxShadow: '0 2px 15px rgba(0,0,0,0.1)', padding: '5px 20px' }}>iframe 模式</h2>
);
iframe 模式

当然,我们也可以使用系统内置的组件:

<Alert type="info">
  哈哈,我是一个 Alert
</Alert>

标签测试 <Badge>Hello</Badge>
内置组件

我们再尝试 build 下组件:

构建

项目中会多一个 es 文件夹:

项目结构

最后,我们 build 下文档:

文档

此时的目录结构会多了个 docs-dist 文件夹:

项目结构

总结:现在我们可以使用 dumi 开发组件库和编写文档了,而且无需配置,只需要快乐地编写代码。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,332评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,508评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,812评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,607评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,728评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,919评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,071评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,802评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,256评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,576评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,712评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,389评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,032评论 3 316
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,798评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,026评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,473评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,606评论 2 350

推荐阅读更多精彩内容