Browse Source

docs(readme): add

1.Add Resources 2.Add Ecosystem
master
dushusir 5 years ago
parent
commit
8278ebaf6f
  1. 33
      README-zh.md
  2. 34
      README.md
  3. 1
      docs/guide/contribute.md
  4. 1
      docs/zh/guide/contribute.md

33
README-zh.md

@ -11,21 +11,32 @@
🚀Luckysheet ,一款纯前端类似excel的在线表格,功能强大、配置简单、完全开源。
## 相关链接
| 源码 | 文档 | Demo | 插件Demo | 论坛 | 资源 |
| ------ | -------- | ------ | ------ | ------ | ------ |
| [Github](https://github.com/mengshukeji/Luckysheet)| [在线文档](https://mengshukeji.github.io/LuckysheetDocs/zh/) | [在线Demo](https://mengshukeji.github.io/LuckysheetDemo) | [导入Excel Demo](https://mengshukeji.github.io/LuckyexcelDemo/) | [中文论坛](https://support.qq.com/product/288322) | [LuckyResources](https://github.com/mengshukeji/LuckyResources) |
| 源码 | 文档 | Demo | 插件Demo | 论坛 |
| ------ | -------- | ------ | ------ | ------ |
| [Github](https://github.com/mengshukeji/Luckysheet)| [在线文档](https://mengshukeji.github.io/LuckysheetDocs/zh/) | [在线Demo](https://mengshukeji.github.io/LuckysheetDemo) / [协同编辑Demo](http://luckysheet.lashuju.com/demo/) | [导入Excel Demo](https://mengshukeji.github.io/LuckyexcelDemo/) | [中文论坛](https://support.qq.com/product/288322) |
| [Gitee镜像](https://gitee.com/mengshukeji/Luckysheet)| [Gitee在线文档](https://mengshukeji.gitee.io/LuckysheetDocs/zh/) | [Gitee在线Demo](https://mengshukeji.gitee.io/luckysheetdemo/) | [Gitee导入Excel Demo](https://mengshukeji.gitee.io/luckyexceldemo/) | [Google Group](https://groups.google.com/g/luckysheet) |
![演示](/docs/.vuepress/public/img/LuckysheetDemo.gif)
## 在线案例
## 插件
- [Luckyexcel](https://gitee.com/mengshukeji/Luckyexcel):excel导入导出库
- [chartMix](https://gitee.com/mengshukeji/chartMix):图表插件
- [协同编辑Demo](http://luckysheet.lashuju.com/demo/)
- [Java后台Luckysheet Server](https://gitee.com/mengshukeji/LuckysheetServer)
## 生态
## 插件
- excel导入导出库: [Luckyexcel](https://gitee.com/mengshukeji/Luckyexcel)
- 图表插件: [chartMix](https://gitee.com/mengshukeji/chartMix)
| 工程 | 描述 |
|---------|-------------|
| [Luckysheet Vue] | 在vue cli 3项目中使用Luckysheet和Luckyexcel|
| [Luckysheet React] | 在React项目中使用Luckysheet |
| [Luckyexcel Node] | 在koa2中使用Luckyexcel |
| [Luckysheet Server] | Java后台Luckysheet Server |
| [Luckysheet Server Starter] | LuckysheetServer 一键docker部署 |
[Luckysheet Vue]: https://gitee.com/mengshukeji/luckysheet-vue
[Luckysheet React]: https://gitee.com/mengshukeji/luckysheet-react
[Luckyexcel Node]: https://gitee.com/mengshukeji/Luckyexcel-node
[Luckysheet Server]: https://gitee.com/mengshukeji/LuckysheetServer
[Luckysheet Server Starter]: https://gitee.com/mengshukeji/LuckysheetServerStarter
## 特性
@ -39,6 +50,10 @@
更详细的功能列表,请查阅:[特性](https://mengshukeji.github.io/LuckysheetDocs/zh/guide/#%E7%89%B9%E6%80%A7)
## 📖 学习资源
社区提供的教程、学习资料及配套解决方案请查阅 [教程与资源](https://mengshukeji.github.io/LuckysheetDocs/zh/guide/resource.html)
## 📜 更新日志
每个版本的详细更改都记录在 [CHANGELOG.md](CHANGELOG.md) 中。

34
README.md

@ -16,21 +16,33 @@ English| [简体中文](./README-zh.md)
🚀Luckysheet is an online spreadsheet like excel that is powerful, simple to configure, and completely open source.
## Links
| Source Code | Documentation | Demo | Plugins Demo | Forum | Resources |
| ------ | -------- | ------ | ------ | ------ | ------ |
| [Github](https://github.com/mengshukeji/Luckysheet)| [Online Documentation](https://mengshukeji.github.io/LuckysheetDocs/) | [Online Demo](https://mengshukeji.github.io/LuckysheetDemo) | [Import Excel Demo](https://mengshukeji.github.io/LuckyexcelDemo/) | [Chinese Forum](https://support.qq.com/product/288322) | [LuckyResources](https://github.com/mengshukeji/LuckyResources) |
| Source Code | Documentation | Demo | Plugins Demo | Forum |
| ------ | -------- | ------ | ------ | ------ |
| [Github](https://github.com/mengshukeji/Luckysheet)| [Online Documentation](https://mengshukeji.github.io/LuckysheetDocs/) | [Online Demo](https://mengshukeji.github.io/LuckysheetDemo) / [Cooperative editing demo](http://luckysheet.lashuju.com/demo/) | [Import Excel Demo](https://mengshukeji.github.io/LuckyexcelDemo/) | [Chinese Forum](https://support.qq.com/product/288322) |
| [Gitee Mirror](https://gitee.com/mengshukeji/Luckysheet)| [Gitee Online Documentation](https://mengshukeji.gitee.io/LuckysheetDocs/) | [Gitee Online Demo](https://mengshukeji.gitee.io/luckysheetdemo/) | [Gitee Import Excel Demo](https://mengshukeji.gitee.io/luckyexceldemo/) | [Google Group](https://groups.google.com/g/luckysheet) |
![Demo](/docs/.vuepress/public/img/LuckysheetDemo.gif)
## Online Case
## Plugins
- [Luckyexcel](https://github.com/mengshukeji/Luckyexcel): Excel import and export library
- [chartMix](https://github.com/mengshukeji/chartMix): Chart plugin
- [Cooperative editing demo](http://luckysheet.lashuju.com/demo/)
- [Java backend Luckysheet Server](https://github.com/mengshukeji/LuckysheetServer)
## Ecosystem
| Project | Description |
|---------|-------------|
| [Luckysheet Vue] | Luckysheet and Luckyexcel in a vue cli3 project |
| [Luckysheet React] | Luckysheet in a React project |
| [Luckyexcel Node] | Use Luckyexcel in koa2 |
| [Luckysheet Server] | Java backend Luckysheet Server |
| [Luckysheet Server Starter] | LuckysheetServer docker deployment startup template |
[Luckysheet Vue]: https://github.com/mengshukeji/luckysheet-vue
[Luckysheet React]: https://github.com/mengshukeji/luckysheet-react
[Luckyexcel Node]: https://github.com/mengshukeji/Luckyexcel-node
[Luckysheet Server]: https://github.com/mengshukeji/LuckysheetServer
[Luckysheet Server Starter]: https://github.com/mengshukeji/LuckysheetServerStarter
## Plugins
- Excel import and export library: [Luckyexcel](https://github.com/mengshukeji/Luckyexcel)
- Chart plugin: [chartMix](https://github.com/mengshukeji/chartMix)
## Features
@ -44,6 +56,10 @@ English| [简体中文](./README-zh.md)
For a more detailed feature list, please refer to: [Features](https://mengshukeji.github.io/LuckysheetDocs/guide/#features)
## 📖 Resources
For the tutorials, learning materials and supporting solutions provided by the community, please refer to [Tutorials and Resources](https://mengshukeji.github.io/LuckysheetDocs/guide/resource.html)
## 📜 Changelog
Detailed changes for each release are documented in the [CHANGELOG.md](CHANGELOG.md).

1
docs/guide/contribute.md

@ -34,7 +34,6 @@ Specific steps:
* Create [Issues](https://github.com/mengshukeji/Luckysheet/issues) and describe the issue clearly
* If you want to solve the issue, assign the issue to your own name. If you just submit a bug/feature/improvement and don’t have time to contribute code, set assignne to empty
* If it is a relatively large feature/improvement, try to output the design document first and follow the [Luckysheet RFC](https://github.com/mengshukeji/Luckysheet-rfcs) process for others to review
* After coding, submit the code
## How to claim Issues

1
docs/zh/guide/contribute.md

@ -35,7 +35,6 @@
* 创建 [Issues](https://github.com/mengshukeji/Luckysheet/issues) ,描述清楚问题
* 如果你要解决该issue则将issue assign到自己名下,如果你仅仅是提交Bug/特性/改进,并没有时间去贡献代码,则assignne设置为空
* 如果是比较大的特性/改进,尽量先输出设计文档,走 [Luckysheet RFC](https://github.com/mengshukeji/Luckysheet-rfcs) 流程,供其他人review
* 编码完成后,提交代码
## 如何认领 Issues

Loading…
Cancel
Save