每个组件库都有它们自己的文档.所以当我们开发完成我们自己的组件库必须也需要一个组件库文档.如果你还不了解如何搭建自己的组件库可以看这里->从零搭建Vue3组件库.看完这篇文章你就会发现原来搭建和部署一个组件库文档是那么的简单.当然部署也不需要你有自己的服务器,你只要有github即可.由于我们的组件库还没有完成,所以下面就以element-plus作为示例来搭建一个文档吧. 安装vitepress 首先新建文件夹就叫kittydocs,执行pnpm init初始化,然后安装vitepress p…

上文 <Vitepress搭建组件库文档(上)-- 基本配置>已经讨论了 vitepress 搭建组件库文档的基本配置,包括站点 Logo.名称.首页 home 布局.顶部导航.左侧导航等.本文进入最重要的部分 -- 如何像 Element Plus 那样一遍代码就可以展示组件的效果和源代码. 1 组件 Demo 的实现效果 vitepress 对 MarkDown 支持比较好,同时对 vue3 也支持较好.常见的在 MD 文档中展示 Demo 有两种方式: 在一个区块内展示,添加插件用来解析…

在 vite 出现以前,vuepress 是搭建组件库文档不错的工具,支持以 Markdown 方式编写文档.伴随着 vite 的发展,vitepress 已经到了 1.0.0-alpha.22 版本,很多博客还是基于 0.x 版本,1.0.0 与 0.22 配置略有差别,尤其是一些 vitepress 插件不支持 1.0.0 版本,如 vitepress-theme-demo(用它可以方便的编写组件 demo).虽然现在 1.0.0 还是 alpha 版本,咱也可以尝试使用,反正遇到什么坑就去…

Web 前端 UI 组件库文档自动化方案 All In One 需求 自动化 动态 好用 markdown element-ui 中示例和说明按照一定规则写在md文件中,调用md-loader将md文件转成相应的页面,组件库维护者,只需要书写md文件即可自动地生成对应的文档页面. MMP, 一个简单的文档,添加了好多脚本,看的太累了,没有耐心了! Storybook https://storybook.js.org/ https://github.com/storybookjs/storyboo…

为了实现组件效果预览及代码展示可折叠功能,使用了插件vuepress-plugin-demo-container 相关配置可参考官网说明文档 第一步 安装插件 npm i - D vuepress-plugin-demo-container 第二步 配置插件 在config.js 文件夹里(.vupress目录下)配置插件 module.exports = { plugins: ['demo-container'] } 第三步 创建components目录,新建md文件,用于展示组件 第四步 在…

周末两天玩了下号称西湖区东半球最牛逼的react文档站点生成工具dumi,顺带结合github pages生成了react-uni-comps文档站, 一套弄下来,感觉真香,现在还只是浅尝,高级的特性还没玩完,文档还需继续打磨完整,不知道是不是东半球最牛逼,西湖全区应该无与伦比了 ,下面是当前文档站移动端和pc端预览截图(整套弄下来花了半天时间!) 桌面端效果(手机界面模拟/桌面端效果/自动根据ts生成的API表格文档) 手机效果(支持light/dark主题) 文档站点制作步骤如下: 安装 d…

简介 本文会从零开始配置一个monorepo类型的组件库,包括规范化配置.打包配置.组件库文档配置及开发一些提升效率的脚本等,monorepo 不熟悉的话这里一句话介绍一下,就是在一个git仓库里包含多个独立发布的模块/包. ps.本文涉及到的工具配置其实在平时开发中一般都不需要自己配置,我们使用的各种脚手架都帮我们搞定了,但是我们至少得大概知道都是什么意思以及为什么,说来惭愧,笔者作为一个三四年工龄的前端老人,基本没有自己动手配过,甚至没有去了解过,所以以下大部分工具都是笔者第一次使用,除了介…

前文回顾:Vue+Spring Boot 前后端分离的商城项目开源啦! Vue 组件千千万,只要不行咱就换. ElementUI 近况 根据我最近的观察,得知一些关于 ElementUI 维护人员都退去的消息,这意味着什么?这意味着后期 ElementUI 将无人维护,就算 Vue3.0 正式版出来 ,ElementUI 的代码也将不会被迭代.从下面的图片中我们也可以看到,最新的一次更新在今年的 5月18日,Github 上 46k+ 的项目,整整三个月没有迭代更新了. 这里放几个知乎链接: e…

前段时间一直在研究Vue组件库,终于在组内派上了用场.来给大家贡献一篇关于Vue组件库的相关知识.经验不多,如果有不合理的地方还请多多指出哦--- 回想一下,在你们公司或者你们小组是否有一个以上的项目需要你维护?你是否遇到两个项目需要开发类似的功能的情况?那么你是怎么做的呢? 有这么三种常用的解决方案: COPY 你可能会说我讲究速度,复制之前的组件到新项目中,慢慢的你会发现随着你的项目的增加代码量在成倍上升,重复工作浪费了你很多时间. 子模块 我可以抽离出所有公共的组件放入一个子模块(git…

最近使用ElementUI做项目的时候用Babel的插件babel-plugin-component做按需加载,使得组件打包的JS和CSS包体积大大缩小,加载速度也大大提升,所有想模仿做一个组件库也来做下按需加载. 首先用Vue CLI 3.0新建一个项目 vue create bes-ui 注意的是cli3的脚手架用的Babel7的配置,只有babel.config.js文件,所以要自己添加.babelrc文件. 项目结构 新建项目之后,可以按照自己的想法建文件结构,也可以按照babel-pl…