|
| 1 | +<p align="center"> |
| 2 | + |
| 3 | +<a href="https://tw.icebreaker.top"> |
| 4 | + |
| 5 | +<img src="./assets/logo.png" alt="weapp-tailwindcss-logo" width="128"> |
| 6 | +</a> |
| 7 | + |
| 8 | +<br> |
| 9 | + |
| 10 | +<h1 align="center">weapp-tailwindcss</h1> |
| 11 | + |
| 12 | +</p> |
| 13 | + |
| 14 | +> 简体中文(zh-cn) | [English](./README_en.md) |
| 15 | +
|
| 16 | + |
| 17 | + |
| 18 | + |
| 19 | + |
| 20 | +[](https://github.com/sonofmagic/weapp-tailwindcss/actions/workflows/test.yml) |
| 21 | +[](https://codecov.io/gh/sonofmagic/weapp-tailwindcss) |
| 22 | + |
| 23 | +> [!NOTE] |
| 24 | +> 降低开发维护成本，提升开发效率的 `小程序` `tailwindcss` 全方面解决方案 |
| 25 | +> |
| 26 | +> 小程序原生工具链 `weapp-vite` 已经发布，使用它改善你的原生小程序开发体验吧，更多详见 [官方文档](https://vite.icebreaker.top/) |
| 27 | +
|
| 28 | +\[[文档地址](https://tw.icebreaker.top)\] \| \[[加入技术交流群](https://tw.icebreaker.top/docs/community/group)\] |
| 29 | + |
| 30 | +- [特性](#特性) |
| 31 | +- [版本对应](#版本对应) |
| 32 | +- [安装与使用方式](#安装与使用方式) |
| 33 | +- [生态和解决方案](#生态和解决方案) |
| 34 | +- [常见问题](#常见问题) |
| 35 | +- [各个框架的模板](#各个框架的模板) |
| 36 | +- [旧版本迁移指南](#旧版本迁移指南) |
| 37 | +- [配置项参考](#配置项参考) |
| 38 | +- [变更日志](#变更日志) |
| 39 | +- [Contribute](#contribute) |
| 40 | +- [License](#license) |
| 41 | +- [Star History](#star-history) |
| 42 | +- [Related projects](#related-projects) |
| 43 | + - [weapp-vite](#weapp-vite) |
| 44 | + |
| 45 | +## 特性 |
| 46 | + |
| 47 | +| 不仅仅是`webpack` | 主流框架与原生开发支持 | |
| 48 | +| --------------------------------------------------- | ----------------------------------------------- | |
| 49 | +|  |  | |
| 50 | + |
| 51 | +核心插件支持 `webpack`/`vite`/`gulp` 为基底的框架类小程序开发，涵盖了市面上几乎所有的主流的开发框架。 |
| 52 | + |
| 53 | +同时也支持最原生的开发者工具创建的原生小程序应用。 |
| 54 | + |
| 55 | +这些插件能够自动识别并精确处理所有 `tailwindcss` 的工具类来适配小程序环境。 |
| 56 | + |
| 57 | +## 版本对应 |
| 58 | + |
| 59 | +目前，`weapp-tailwindcss` 的 `2.x` 和 `3.x` 支持最新版本的 `tailwindcss v3.x.x` 版本和 `webpack5`，`webpack4`, `vite` 和 `gulp`。从 `3.2.0` 开始，`weapp-tailwindcss` 支持最原生的小程序开发方式。 |
| 60 | + |
| 61 | +> 如果你还在使用 `tailwindcss@2` 版本，那你应该使用从 `weapp-tailwindcss/webpack4` 导出的本插件的 `postcss7` `webpack4` 版本。另外请确保你的 `nodejs` 版本 `>=16.6.0`。目前低于 `16` 的长期维护版本(`偶数版本`) 都已经结束了生命周期，建议安装 `nodejs` 的 `LTS` 版本，详见 [nodejs/release](https://github.com/nodejs/release) |
| 62 | +
|
| 63 | +## [安装与使用方式](https://tw.icebreaker.top/docs/quick-start/install) |
| 64 | + |
| 65 | +## [生态和解决方案](https://tw.icebreaker.top/docs/community/templates) |
| 66 | + |
| 67 | +## [常见问题](https://tw.icebreaker.top/docs/issues/) |
| 68 | + |
| 69 | +## [各个框架的模板](https://tw.icebreaker.top/docs/community/templates) |
| 70 | + |
| 71 | +## [旧版本迁移指南](https://tw.icebreaker.top/docs/migrations/v2) |
| 72 | + |
| 73 | +## [配置项参考](https://tw.icebreaker.top/docs/api/interfaces/UserDefinedOptions) |
| 74 | + |
| 75 | +## [变更日志](./CHANGELOG.md) |
| 76 | + |
| 77 | +## Contribute |
| 78 | + |
| 79 | +我们邀请你来贡献和帮助改进 `weapp-tailwindcss` 💚💚💚 |
| 80 | + |
| 81 | +以下有几个方式可以参与: |
| 82 | + |
| 83 | +- 报告错误：如果您遇到任何错误或问题，请提`issue`并提供完善的错误信息和复现方式。 |
| 84 | +- 建议：有增强 `weapp-tailwindcss` 的想法吗？请提 `issue` 来分享您的建议。 |
| 85 | +- 文档：如果您对文档有更好的见解或者更棒的修辞方式，欢迎 `pr`。 |
| 86 | +- 代码：任何人的代码都不是完美的，我们欢迎你通过 `pr` 给代码提供更好的质量与活力。 |
| 87 | + |
| 88 | +## License |
| 89 | + |
| 90 | +[MIT](./LICENSE) |
| 91 | + |
| 92 | +## Star History |
| 93 | + |
| 94 | +[](https://star-history.com/#sonofmagic/weapp-tailwindcss&Date) |
| 95 | + |
| 96 | +## Related projects |
| 97 | + |
| 98 | +### weapp-vite |
| 99 | + |
| 100 | +[weapp-vite](https://vite.icebreaker.top/): 把现代化的开发模式带入小程序开发! |
0 commit comments