上文 <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 版本,咱也可以尝试使用,反正遇到什么坑就去…
每个组件库都有它们自己的文档.所以当我们开发完成我们自己的组件库必须也需要一个组件库文档.如果你还不了解如何搭建自己的组件库可以看这里->从零搭建Vue3组件库.看完这篇文章你就会发现原来搭建和部署一个组件库文档是那么的简单.当然部署也不需要你有自己的服务器,你只要有github即可.由于我们的组件库还没有完成,所以下面就以element-plus作为示例来搭建一个文档吧. 安装vitepress 首先新建文件夹就叫kittydocs,执行pnpm init初始化,然后安装vitepress p…
Web 前端 UI 组件库文档自动化方案 All In One 需求 自动化 动态 好用 markdown element-ui 中示例和说明按照一定规则写在md文件中,调用md-loader将md文件转成相应的页面,组件库维护者,只需要书写md文件即可自动地生成对应的文档页面. MMP, 一个简单的文档,添加了好多脚本,看的太累了,没有耐心了! Storybook https://storybook.js.org/ https://github.com/storybookjs/storyboo…
周末两天玩了下号称西湖区东半球最牛逼的react文档站点生成工具dumi,顺带结合github pages生成了react-uni-comps文档站, 一套弄下来,感觉真香,现在还只是浅尝,高级的特性还没玩完,文档还需继续打磨完整,不知道是不是东半球最牛逼,西湖全区应该无与伦比了 ,下面是当前文档站移动端和pc端预览截图(整套弄下来花了半天时间!) 桌面端效果(手机界面模拟/桌面端效果/自动根据ts生成的API表格文档) 手机效果(支持light/dark主题) 文档站点制作步骤如下: 安装 d…
npm地址 github源码 开篇-环境配置 环境配置: 使用vue-cli搭建项目框架,需要用vue3的话,得先把vue-cli的版本升级到vue-cli@5以上 npm install -g @vue/cli 官网相关说明: 配置预选项: 后来后悔自己加上Linter/Formatter了 选版本号:3.x 选css扩展语言:dart-scss <为什么选dart-scss?> dart-scss比node-scss快很多(node-scss基于ruby的,运行速度很慢) 后续更新的功能也…
为了实现组件效果预览及代码展示可折叠功能,使用了插件vuepress-plugin-demo-container 相关配置可参考官网说明文档 第一步 安装插件 npm i - D vuepress-plugin-demo-container 第二步 配置插件 在config.js 文件夹里(.vupress目录下)配置插件 module.exports = { plugins: ['demo-container'] } 第三步 创建components目录,新建md文件,用于展示组件 第四步 在…
前文已经初始化了 workspace-root,从本文开始就需要依次搭建组件库.example.文档.cli.本文内容是搭建 组件库的开发环境. 1 packages 目录 前面在项目根目录下创建了 packages 目录,该目录存放组件库的所有组件及组件库的入口.该目录中已经创建了两个子目录 foo 和 yyg-demo-ui.这两个目录是干嘛用的呢? 1.1 foo 目录 foo 目录代表一个示例组件,后面咱们会使用该组件来测试组件库在 example 和组件库文档中是否能正常运行.后续要开…
前言 各种编程语言均有其优势和生态,有兴趣的朋友完全可以涉猎多门语言.在平常的工作之中,也可以尝试选择相对适合的编程语言来完成相关的工作. 在团队技术文档站搭建这块,笔者尝试了许多框架,最终还是选择了Hexo,主要是由于其丰富的主题和插件,并且灵活和高度可定制化,改起来也非常方便.我们团队文档站即使用Hexo来构建,并且基于容器配置了完整的代码流水线:docs.xin-lai.com 如果对站点配置.主题.插件存在疑问,可以加群沟通. 目录 官方镜像  编写一个简单的Web服务器  编码 编写D…
传智播客作为中国IT培训的领军品牌,一直把握技术趋势,给大家带来最新的技术分享!传智播客C/C++主流开发环境免费分享视频文档中,就有写一个helloworld程序的示范.火速前来下载吧 所谓"工欲善其事,必先利其器". 欲学C/C++,必先搭建环境,欲成为C/C++高手,必先跑起来helloworld! C/C++ IDE只是工具--剑,C/C++语言就是剑法.欲雄霸天下,必须精通各种剑,精通各路剑法.请大家认真关注http://c.itcast.cn最新技术视频. (有图有真相)C…