前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >在 cra 等非 umi 项目中使用 dumi2

在 cra 等非 umi 项目中使用 dumi2

作者头像
德顺
发布2023-08-25 13:38:40
3580
发布2023-08-25 13:38:40
举报
文章被收录于专栏:前端资源前端资源

dumi 是一个基于 Umi 的静态站点框架,可以快速编写组件文档和 Demo。如果项目是使用 Umi 搭建的,使用 dumi 非常简单,只需要安装 dumi 并在 src 目录下创建 .md 文件即可。但如果项目是使用 cra (create-react-app) 或其他技术栈搭建的,就需要做一些额外的配置。本文将介绍如何在 cra 等非 umi 项目中使用 dumi。

  1. 安装模块
代码语言:javascript
复制
yarn add dumi cross-env -D
  1. 增加启动命令,修改 package.json
代码语言:javascript
复制
"scripts": {
  "dumi": "cross-env APP_ROOT=dumi dumi dev",
  "dumi-build": "cross-env APP_ROOT=dumi dumi build"
},
  1. 增加配置,新建 .dumirc
代码语言:javascript
复制
export default {
  chainWebpack(memo) {
    memo.plugins.delete('copy');
  },
};
  1. 新建文档目录 dumi/docs/,这里的 dumi 目录即第二步中配置的环境变量,你可以随意同步修改。
  2. 新建文档 dumi/docs/index.md
代码语言:javascript
复制
# 这是一个 Dumi 结合 create-react-app 的 Demo
  1. dumi 的临时文件添加到 .gitignore 中
代码语言:javascript
复制
.dumi
  1. 启动文档

现在你可以运行 yarn dumi 命令来启动文档,访问 http://localhost:8000/ 即可查看。如果想要构建文档并部署到 GitHub Pages 或其他平台,你可以运行 yarn dumi-build 命令来生成静态文件,并根据部署平台的要求进行相应的配置。

通过上面的步骤,就可以在 cra 等非 umi 项目中使用 dumi 来编写和调试组件文档了。

当然,这只是一个基本的入门教程,dumi 还有很多强大的功能和特性等待你去探索和利用。如果你想了解更多关于 dumi 的信息,可以访问它的官方网站 https://d.umijs.org/ 。

未经允许不得转载:w3h5-Web前端开发资源网 » 在 cra 等非 umi 项目中使用 dumi2

本文参与 腾讯云自媒体分享计划,分享自作者个人站点/博客。
如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档