webpack 调试入口-Vue 组件库系列 2:构建自己的 UI 库文档(旧版本的解决方案)。

2023-10-08 0 4,804 百度已收录

上一篇文章实现了封装个人组件库的功能,有了组件库,其实必须要有配套文档,这样信使使用起来更方便。打包的dist目录终于可以放在服务器上,直接访问文档了。

在项目中配置打包示例

在下一篇文章中,执行 packaging 命令会将项目打包到 lib 下,打包包的目录结构适合作为 npm 包直接分发webpack 调试入口,使用导入时介绍。没有 HTML 文件条目,因此必须有文档,可以直接在浏览器中访问,并且需要重新配置打包。

细心的童鞋会发现,我们的文档是 vue 文件,而 ElementUI 是降价格式的文档,句子介绍,易于配置,那么他们是怎么做到的呢?本文将引导您完成 MD 文档的实施

打包示例的目录结构和 webpack 配置

Package.json 降低打包命令 “build_example”: “nodebuild/build.jsexamples”

其次,在src级别降低示例目录(删除之前的内容),并存储文档的相关文件

示例目录:

1. 资产目录存储静态资源依赖

2. 组件存储 VUE 组件3. 文档

目录存储 .md 文件、文档和文档

4. main.js将用作打包门户,其中介绍了项目组件、第三方依赖项:element-UI、路由配置等

webpack 调试入口-Vue 组件库系列 2:构建自己的 UI 库文档(旧版本的解决方案)。

5. 路由.js路由配置

6. 索引.html作为打包的 HTML 模板

7、应用程序

三、webpack相关配置

降低构建目录中的 webpack.prod.examples.conf 文件.js配置打包示例。这个文件是 vue-cli 构建项目中的 webpack.prod.conf.js略有改动

1. 添加输出导出配置,因为此值之前设置为 config: /lib,此处将值设置为 : /dist,包示例,输出到 dist

2. 将打包条目设置为示例下的主.js

3. 将 HTML 模板设置为 ./examples/index.html

另外,在构建/构建.js中,需要确定示例参数并修改输出退出路径,如图所示:

webpack 调试入口-Vue 组件库系列 2:构建自己的 UI 库文档(旧版本的解决方案)。

相关依赖项安装

npm i highlight -D //安装语法高亮
npm i markdown-it markdown-it-anchor markdown-it-container -D // 安markdown 相关依赖
npm i vue-markdown-loader -D //安装vue-markdown-loader,解析.md文件为.vue文件

网页包相关配置

安装了 vue-markdown-loader 解析 .md 文件,在 webpack.base.conf .js文件中,需要相关的加载器配置,这里的配置与 element-ui 副本中的代码有关。更改如下:

首先,将 strip-tags 文件缩减到 /build 目录下,strip-tags 内容如下:

对 webpack.base.conf 的更改.js

1. 添加工具功能

2. 新增 .md

相关加载器配置,将 .md 文件解析为 .vue 文件webpack 调试入口,同时解析处理:::d emo::::代码块等,解析处理:::d emo::::代码块用于 demo-blockvue 组件,并传入相应的参数

webpack 调试入口-Vue 组件库系列 2:构建自己的 UI 库文档(旧版本的解决方案)。

文档部分

配置结束,然后进入示例的文档部分

1. 编制主要.js入境文件

在入口文件中,介绍相关依赖关系、项目样式入口、路由、组件和元素 UI

2. 设置路由配置路由.js

配置路由时,将与路由路径对应的组件设置为引入的 .md 文件

3. App.vue 和相关布局组件

1、应用程序

webpack 调试入口-Vue 组件库系列 2:构建自己的 UI 库文档(旧版本的解决方案)。

2、标题

3、menu.vue(这里我们借用元素-UI菜单组件)。

重要组件demoBlock.vue

demoBlock 组件是解析 :::

:d .md 中的 emo::: 代码块,这里的 demoBlock.vue 文件是副本的 element-ui 代码,略有改动(这部分对应加载器中的配置)。

主代码在这里,你可以去 element-ui 查看样式文件

webpack 调试入口-Vue 组件库系列 2:构建自己的 UI 库文档(旧版本的解决方案)。

5. 文档中的 .md 文档文件

编译 .md 文件时,有几点需要记住:带有标签的

交互式文档,这些标签定义了需要在标签元素中导入的 Vue 实例(本节将是下一个版本的重点)。

在 :::d emo:::code 块中定义的模板用作导入的 vue 实例的模板,代码块中的内容仅用作显示。

.md 文件会粘贴错误,这里只做截图,需要的人可以走进 github 查看 ithub

6. 风格调整

与样式相关的调整代码在此不单独列出,所需的合作伙伴可以进入 GitHub 查看

发展

开发中的调试

将 webpack.dev.conf .js文件的条目设置为 ./examples/main.js,以便在开发组件时进行调试,也可以调试到文档。

entry: {
 app: './examples/main.js'
 },

结束语

本文将引导您完成记录 element-ui 组件库的过程,您可以参考反例集成到您自己的组件库中。同时,本文内容中描述了这些方法的“缺点”和下一版本的改进方向,我们将继续沿着这个方向构建我们的组件库文档

收藏 (0) 打赏

感谢您的支持,我会继续努力的!

打开微信/支付宝扫一扫,即可进行扫码打赏哦,分享从这里开始,精彩与您同在
点赞 (0)

悟空资源网 webpack webpack 调试入口-Vue 组件库系列 2:构建自己的 UI 库文档(旧版本的解决方案)。 https://www.wkzy.net/game/198967.html

常见问题

相关文章

官方客服团队

为您解决烦忧 - 24小时在线 专业服务