{"id":17650408,"url":"https://github.com/jsxiaosi/xs-components-lib","last_synced_at":"2025-04-15T01:20:48.210Z","repository":{"id":57988267,"uuid":"466711180","full_name":"jsxiaosi/xs-components-lib","owner":"jsxiaosi","description":"🎉🎉🎉A ready-to-use component library template allows rapid development of your component library。一款开封即用的组件库模版，让你快速开发属于你的组件库","archived":false,"fork":false,"pushed_at":"2024-12-08T09:44:40.000Z","size":1989,"stargazers_count":62,"open_issues_count":0,"forks_count":12,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-10T18:08:23.535Z","etag":null,"topics":["component","component-library","glup","rollup","typescript","vitepress","vue3"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jsxiaosi.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-03-06T11:02:01.000Z","updated_at":"2025-03-29T08:13:06.000Z","dependencies_parsed_at":"2023-12-23T16:26:22.317Z","dependency_job_id":"63dacf18-5788-4269-a44b-b93ab0f8843f","html_url":"https://github.com/jsxiaosi/xs-components-lib","commit_stats":{"total_commits":96,"total_committers":4,"mean_commits":24.0,"dds":0.03125,"last_synced_commit":"db29719dcca828383b46c36fd11b3c760936ee93"},"previous_names":[],"tags_count":7,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsxiaosi%2Fxs-components-lib","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsxiaosi%2Fxs-components-lib/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsxiaosi%2Fxs-components-lib/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsxiaosi%2Fxs-components-lib/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jsxiaosi","download_url":"https://codeload.github.com/jsxiaosi/xs-components-lib/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248986483,"owners_count":21194046,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["component","component-library","glup","rollup","typescript","vitepress","vue3"],"created_at":"2024-10-23T11:38:12.295Z","updated_at":"2025-04-15T01:20:48.188Z","avatar_url":"https://github.com/jsxiaosi.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align='center' \u003e\u003ch2\u003eComponent library template\u003c/h2\u003e\u003c/div\u003e\n\n\u003cdiv align='left' \u003e\nComponent library template developed based on \u003ccode\u003eVue3\u003c/code\u003e, \u003ccode\u003eVitePress\u003c/code\u003e, \u003ccode\u003eRollup\u003c/code\u003e, \u003ccode\u003eGulp\u003c/code\u003e and other mainstream technologies\u003cbr/\u003e\nBuilt-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.\u003cbr/\u003e\nBuilt-in VitePress theme eliminates the trouble of writing style, with its own night mode, and can customize the theme.\n\u003c/div\u003e\n\u003cbr/\u003e\n\n\u003cp align='center'\u003e\n  \u003cb\u003eEnglish\u003c/b\u003e | \n  \u003ca href=\"https://github.com/jsxiaosi/xs-components-lib/blob/main/README.zh-CN.md\"\u003e简体中文\u003c/a\u003e\n\u003c/p\u003e\n\n## Docs\n\n\u003chttps://xs-com-lib.netlify.app\u003e\n\n## Features\n\n- **🚀 Latest technology stack**\u003cbr/\u003e\n  It is developed using front-end cutting-edge technologies such as Vue3/Rollup/Gulp\n- **📦 Out of the box**\u003cbr/\u003e\n  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.\n- **🔗 Support CDN introduction**\u003cbr/\u003e\n  Support the packaging and output of compact CDN modules, and simultaneously support UnPkg and JsDelivr CDN introduction methods.\n- **⚡️ VitePress**\u003cbr/\u003e\n  Vue official document theme, free of the trouble of writing style, with its own night mode, customizable theme.\n- **💻 One-click template generation command**\u003cbr/\u003e\n  Say goodbye to the trouble of manually creating development templates by machine, and generate development templates quickly and easily with one command.\n- **🚧 Specification inspection**\u003cbr/\u003e\n  Built-in Eslint, Prettier and CommitLint tools can better unify your code style and submit inspection specifications.\n\n## Prepare\n\n- [Node](http://nodejs.org/) and [Git](https://git-scm.com/) - project development environment\n- [Vite](https://cn.vitejs.dev/) - Familiar with Vite features\n- [Vue3](https://v3.cn.vuejs.org/) - Familiar with Vue basic syntax\n- [Es6+](http://es6.ruanyifeng.com/) - familiar with Es6 basic syntax\n- [VitePress](https://vuepress.vuejs.org/) - familiar with the basic use of VitePress\n\n## Installation and use\n\n- Get project code (Https or SSH)\n\n```bash\ngit clone https://github.com/jsxiaosi/xs-components-lib.git\n\ngit clone git@github.com:jsxiaosi/xs-components-lib.git\n```\n\nAlternatively, you can use the [`xs-cli`](https://github.com/jsxiaosi/xs-cli)to quickly create one\n\n```bash\nnpx @jsxiaosi/xs-cli create [project-name]\n```\n\n- Installation Dependencies\n\n```bash\npnpm install\n```\n\n### Developer\n\n- Run built-in template debugging component\n\n```bash\nnpm run dev\n```\n\n- Run the VitePress document\n\n```bash\nnpm run docs:dev\n```\n\n- Create component template\n\n```bash\nnpm run ct 'Component name'\n```\n\n### Production\n\n- Package Component Library\n\n```bash\nnpm run build\n```\n\n- Packaging a VitePress document\n\n```bash\nnpm run docs:build\n```\n\n## Git Contribution submission specification\n\n- Refer to [Vue](https://github.com/vuejs/vue/blob/dev/.github/COMMIT_CONVENTION.md) specification\n\n  - `feat` New Features\n  - `fix` Repair defects\n  - `docs` Document change\n  - `style` Code format\n  - `refactor` Code refactoring\n  - `perf` Performance optimization\n  - `test` Add neglected tests or changes to existing tests\n  - `build` Build processes, external dependency changes (such as upgrading npm packages, modifying packaging configurations, etc.)\n  - `ci` Modify CI configuration and scripts\n  - `revert` Roll back the commit\n  - `chore` Changes to the build process or tools and libraries (do not affect source files)\n  - `wip` Under development\n  - `types` Type definition file modification\n\n- Or submit with instructions\n\n```bash\nnpm run cz\n```\n\n### Specification related\n\n- [EsLint](https://eslint.org/) - Js syntax detection\n- [StyleLint](https://stylelint.io/) - Style syntax detection\n- [CommitLint](https://commitlint.js.org/#/) - Git commit commit specification detection\n\n## Catalogue\n\n```bash\n.\n├── LICENSE\n├── README.md\n├── build\n├── commitlint.config.js\n├── docs                                # Vitepress document directory\n├── effect                              # Commissioning template\n├── lib\n├── node_modules\n├── package-lock.json\n├── package.json\n├── packages                            # Common component directory\n│   ├── components                      # Component storage directory\n│   ├── hooks                           # Hooks storage directory\n│   ├── theme-default                   # Component style storage directory\n│   ├── utils                           # Public method storage directory\n├── postcss.config.js\n├── prettier.config.js\n├── script\n├── stylelint.config.js\n├── tsconfig.json\n└── typings\n```\n\n## Thanks for the help of the following excellent projects\n\n- [Element-Plus](https://github.com/element-plus/element-plus)\n- [Naive-UI](https://github.com/tusen-ai/naive-ui)\n\n## maintainers\n\n[@jsxiaosi](https://github.com/jsxiaosi)\n\n## License\n\n[MIT © 2022](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjsxiaosi%2Fxs-components-lib","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjsxiaosi%2Fxs-components-lib","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjsxiaosi%2Fxs-components-lib/lists"}