wr-comp-ui

风行编辑器的组件库

Usage no npm install needed!

<script type="module">
  import wrCompUi from 'https://cdn.skypack.dev/wr-comp-ui';
</script>

README

wr-comp

这是风行系统的组件库工程项目

安装

npm install

运行开发

npm run serve

打包组件

npm run lib

打包文档

npm run doc

如何新建一个组件开发

新组件放在packages文件夹下，同时再packages/index.js里面引入新开发的组件，配置上对应的文档路由，就可以展示和开发了。路由配置见下面【组件文档开发说明】

├── hello-world
│   ├── index.js
│   └── src
│       └── hello-world.vue

组件文档开发说明

文档展示放在examples文件夹下，如果正常开发，只需要在examples/docs下面添加一个md文件，并且在nav.config.json里面加入以下路由就行

如果需要修改样式，就要在exapmles对应的文件夹下处理了

文档编写说明

  • 正常文字描述以及组件展示可以直接写，参考hello-world文件
  • 组件代码示例写到::: demo :::这个模块里面
  • 如果需要对某一行加入样式，可以使用markdown-it-decorate语法，在某一行前面加入<!-- {.title-2} -->这样，就可以添加class属性

components说明

examples/components下面放置的是文档展示相关的组件，并不是组件库组件

问题解决