Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jsxiaosi/xs-components-lib
๐๐๐A ready-to-use component library template allows rapid development of your component libraryใไธๆฌพๅผๅฐๅณ็จ็็ปไปถๅบๆจก็๏ผ่ฎฉไฝ ๅฟซ้ๅผๅๅฑไบไฝ ็็ปไปถๅบ
https://github.com/jsxiaosi/xs-components-lib
component component-library glup rollup typescript vitepress vue3
Last synced: 3 months ago
JSON representation
๐๐๐A ready-to-use component library template allows rapid development of your component libraryใไธๆฌพๅผๅฐๅณ็จ็็ปไปถๅบๆจก็๏ผ่ฎฉไฝ ๅฟซ้ๅผๅๅฑไบไฝ ็็ปไปถๅบ
- Host: GitHub
- URL: https://github.com/jsxiaosi/xs-components-lib
- Owner: jsxiaosi
- License: mit
- Created: 2022-03-06T11:02:01.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-23T06:11:18.000Z (10 months ago)
- Last Synced: 2024-04-23T22:37:05.818Z (9 months ago)
- Topics: component, component-library, glup, rollup, typescript, vitepress, vue3
- Language: TypeScript
- Homepage:
- Size: 2.12 MB
- Stars: 60
- Watchers: 4
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Component library template
Component library template developed based on Vue3, VitePress, Rollup, Gulp and other mainstream technologies
Built-in packaging components, Hooks, Utils, which can be introduced on demand, support TypeScript, and enable all attention to focus on document writing and component development.
Built-in VitePress theme eliminates the trouble of writing style, with its own night mode, and can customize the theme.
English |
็ฎไฝไธญๆ
## Docs
## Features
- **๐ Latest technology stack**
It is developed using front-end cutting-edge technologies such as Vue3/Rollup/Gulp
- **๐ฆ Out of the box**
Built-in packaging can be introduced on demand, and TypeScript is supported, so that all attention can be focused on document writing and component development.
- **๐ Support CDN introduction**
Support the packaging and output of compact CDN modules, and simultaneously support UnPkg and JsDelivr CDN introduction methods.
- **โก๏ธ VitePress**
Vue official document theme, free of the trouble of writing style, with its own night mode, customizable theme.
- **๐ป One-click template generation command**
Say goodbye to the trouble of manually creating development templates by machine, and generate development templates quickly and easily with one command.
- **๐ง Specification inspection**
Built-in Eslint, Prettier and CommitLint tools can better unify your code style and submit inspection specifications.
## Prepare
- [Node](http://nodejs.org/) and [Git](https://git-scm.com/) - project development environment
- [Vite](https://cn.vitejs.dev/) - Familiar with Vite features
- [Vue3](https://v3.cn.vuejs.org/) - Familiar with Vue basic syntax
- [Es6+](http://es6.ruanyifeng.com/) - familiar with Es6 basic syntax
- [VitePress](https://vuepress.vuejs.org/) - familiar with the basic use of VitePress
## Installation and use
- Get project code (Https or SSH)
```bash
git clone https://github.com/jsxiaosi/xs-components-lib.git
git clone [email protected]:jsxiaosi/xs-components-lib.git
```
Alternatively, you can use the [`xs-cli`](https://github.com/jsxiaosi/xs-cli)to quickly create one
```bash
npx @jsxiaosi/xs-cli create [project-name]
```
- Installation Dependencies
```bash
pnpm install
```
### Developer
- Run built-in template debugging component
```bash
npm run dev
```
- Run the VitePress document
```bash
npm run docs:dev
```
- Create component template
```bash
npm run ct 'Component name'
```
### Production
- Package Component Library
```bash
npm run build
```
- Packaging a VitePress document
```bash
npm run docs:build
```
## Git Contribution submission specification
- Refer to [Vue](https://github.com/vuejs/vue/blob/dev/.github/COMMIT_CONVENTION.md) specification
- `feat` New Features
- `fix` Repair defects
- `docs` Document change
- `style` Code format
- `refactor` Code refactoring
- `perf` Performance optimization
- `test` Add neglected tests or changes to existing tests
- `build` Build processes, external dependency changes (such as upgrading npm packages, modifying packaging configurations, etc.)
- `ci` Modify CI configuration and scripts
- `revert` Roll back the commit
- `chore` Changes to the build process or tools and libraries (do not affect source files)
- `wip` Under development
- `types` Type definition file modification
- Or submit with instructions
```bash
npm run cz
```
### Specification related
- [EsLint](https://eslint.org/) - Js syntax detection
- [StyleLint](https://stylelint.io/) - Style syntax detection
- [CommitLint](https://commitlint.js.org/#/) - Git commit commit specification detection
## Catalogue
```bash
.
โโโ LICENSE
โโโ README.md
โโโ build
โโโ commitlint.config.js
โโโ docs # Vitepress document directory
โโโ effect # Commissioning template
โโโ lib
โโโ node_modules
โโโ package-lock.json
โโโ package.json
โโโ packages # Common component directory
โย ย โโโ components # Component storage directory
โย ย โโโ hooks # Hooks storage directory
โย ย โโโ theme-default # Component style storage directory
โย ย โโโ utils # Public method storage directory
โโโ postcss.config.js
โโโ prettier.config.js
โโโ script
โโโ stylelint.config.js
โโโ tsconfig.json
โโโ typings
```
## Thanks for the help of the following excellent projects
- [Element-Plus](https://github.com/element-plus/element-plus)
- [Naive-UI](https://github.com/tusen-ai/naive-ui)
## maintainers
[@jsxiaosi](https://github.com/jsxiaosi)
## License
[MIT ยฉ 2022](./LICENSE)