前言: 开发 vue 组件库需要提供组件的使用文档,最好是有渲染到浏览器的 demo 实例,既能操作又能查看源代码。markdown 作为常用的文档编写载体,如果能在里面直接写 vue 组件,同时编写使用说明就再好不过。流行的组件库 element-ui 的文档就是用 markdown 写出来 ...
对于前端团队来说,公共组件库是必须的,紧接着就是完善组件库的文档 社区里关于快速生成文档的工具有很多,如 StoryBook Docz Gatsby 在调研了几种文档工具之后,最终我选择了 umi 家族的另一个成员:dumi 因为它集成了 docz,以及打包工具father build,同时支持创建自己的Markdown 组件 当然最重要的是,我的项目是基于 umi 构建的 一 启动 首先创建一个 ...
2021-09-23 16:22 0 795 推荐指数:
前言: 开发 vue 组件库需要提供组件的使用文档,最好是有渲染到浏览器的 demo 实例,既能操作又能查看源代码。markdown 作为常用的文档编写载体,如果能在里面直接写 vue 组件,同时编写使用说明就再好不过。流行的组件库 element-ui 的文档就是用 markdown 写出来 ...
基于 dumi+father-build 的组件库开发和文档模板 github 注意事项 如果需要推送到 npm 或者私有 npm 域 修改 package.json 的 registry github ...
写在前面:周末的日子是让人轻松和愉快的,正好有更多的时间去总结归纳一周的事情,先将未完成部分继续上吧 前面的一章已经介绍了关于vue-styleguist的配置的问题,本章将继续如何在vue中去编写自己的组件demo和生成自己的表格呢~ git 地址:https://github.com ...
写在前面:前面已经介绍了vue-press和vue-gocgen-cli和vue-press的区别和联系,本篇文章主要介绍关于vue-styleguidist的使用 官网强大的api连接 强大的配置文件链接 https://vue-styleguidist.github.io ...
使用DocFX命令行生成文档 使用docfx 命令 1.下载 https://github.com/dotnet/docfx/releases 2.使用 创建初始项目 此命令生成一个名为docfx_project的默认项目。 3.生成网站 现在你可以访问 ...
最近找了一些文档的生成工具,结果发现了这个 React Styleguidist 可以通过注释,自动生成对应的文档,对于 react 库来说十分方便 安装 typescript 支持 配置 这次的例子是使用 cra 来创建的项目,还有其他项目也是支持的 点击参考 ...
写在前面:在我们的印象使用中,vue除了写业务代码没有特别新奇的功能了,最近在着手探索了如何利用vue进行组件库文档编写功能呢? 循序渐进进行学习~ 本章介绍两种文档生成方法不同的地方以及优点和缺点 vuepress 网站参考连接:https://www.vuepress.cn ...