Git Product home page Git Product logo

clown-plus's Introduction

简介

基于Vue3,VitePress,ElementPush, Rollup等主流技术开发的组件库模板

特性

  • 最新技术栈:使用 Vue3/vite2 等前端前沿技术开发
  • 组件文档:使用 VitePress 内置文档
  • 支持:支持 TypeScript,支持按需引入
  • 模板: 内置指令一键生成开发模板

准备

安装使用


- 安装依赖

```bash
npm install

# 建议不要直接使用 cnpm 安装以来,会有各种诡异的 bug。可以通过如下操作解决 npm 下载速度慢的问题
# 如果下载依赖慢可以使用淘宝镜像源安装依赖
npm install --registry=https://registry.npm.taobao.org

Developer

  • 运行内置模板调试组件
# 生成组件库代码
npm run build
# 起一个vite server
npm run dev
  • 运行 VitePress 文档
npm run docs:dev
  • 创建组件模板
npm run ct '组件名称'

Production

  • 打包组件库
npm run build
  • 打包 VitePress 文档
npm run docs:build

Git 提交规范

  • 参考 vue 规范

    • feature 增加新功能
    • fixbug 修复问题/BUG
    • style 不影响程序逻辑的代码修改(修改空白字符,格式缩进,补全缺失的分号等,没有改变代码逻辑)
    • perf 优化/性能提升
    • refactor 重构
    • revert 撤销修改
    • docs 文档/注释
    • chore 依赖更新/脚手架配置修改等
  • 或使用指令提交

npm run commit

规范相关

目录

.
├── LICENSE
├── README.md
├── build
├── commitlint.config.js
├── docs                                # vitepress文档目录
├── effect                              # 调试模板
├── lib
├── node_modules
├── package-lock.json
├── package.json
├── packages                            # 公共组件目录
│   ├── components                      # 组件存放目录
│   ├── hooks                           # hooks存放目录
│   ├── theme-default                   # 组件样式存放目录
│   ├── utils                           # 公共方法存放目录
├── postcss.config.js
├── prettier.config.js
├── script
├── stylelint.config.js
├── tsconfig.json
└── typings

组件列表

  • button
  • yamlEdit

参考

https://github.com/SuperCuteXiaoSi/xiaosiCommitLib

License

MIT © 2021

clown-plus's People

Watchers

Clown avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.