Commit dd6ca918232cee3eecfc3a494f720d417be7c0ce
1 parent
463307ef
docs: add chinese docs about ecosystem
Showing
3 changed files
with
58 additions
and
9 deletions
docs/.vuepress/config.js
| @@ -35,6 +35,7 @@ module.exports = { | @@ -35,6 +35,7 @@ module.exports = { | ||
| 35 | // { text: 'Config', link: '/config/' }, | 35 | // { text: 'Config', link: '/config/' }, |
| 36 | // { text: 'API', link: '/api/' }, | 36 | // { text: 'API', link: '/api/' }, |
| 37 | { text: 'Website', link: 'https://h5.luban-h5.com' }, | 37 | { text: 'Website', link: 'https://h5.luban-h5.com' }, |
| 38 | + { text: 'Ecosystem', link: '/zh/ecosystem/' }, | ||
| 38 | { text: 'Changelog', link: 'https://github.com/ly525/luban-h5/releases' }, | 39 | { text: 'Changelog', link: 'https://github.com/ly525/luban-h5/releases' }, |
| 39 | { text: 'Api Docs', link: 'https://h5.luban-h5.com/documentation/' }, | 40 | { text: 'Api Docs', link: 'https://h5.luban-h5.com/documentation/' }, |
| 40 | ], | 41 | ], |
| @@ -52,11 +53,10 @@ module.exports = { | @@ -52,11 +53,10 @@ module.exports = { | ||
| 52 | ], | 53 | ], |
| 53 | }, | 54 | }, |
| 54 | { | 55 | { |
| 55 | - collapsable: true, | ||
| 56 | - title: '💡Implementation', | 56 | + collapsable: false, |
| 57 | + title: '🤝社区生态-周边建设', | ||
| 57 | children: [ | 58 | children: [ |
| 58 | - '/en/implementation/code-structure', | ||
| 59 | - '/en/implementation/form-submit', | 59 | + '/zh/ecosystem/', |
| 60 | ], | 60 | ], |
| 61 | }, | 61 | }, |
| 62 | { | 62 | { |
| @@ -80,6 +80,14 @@ module.exports = { | @@ -80,6 +80,14 @@ module.exports = { | ||
| 80 | '/en/migration-guide/', | 80 | '/en/migration-guide/', |
| 81 | ], | 81 | ], |
| 82 | }, | 82 | }, |
| 83 | + { | ||
| 84 | + collapsable: true, | ||
| 85 | + title: '💡Implementation', | ||
| 86 | + children: [ | ||
| 87 | + '/en/implementation/code-structure', | ||
| 88 | + '/en/implementation/form-submit', | ||
| 89 | + ], | ||
| 90 | + }, | ||
| 83 | ], | 91 | ], |
| 84 | }, | 92 | }, |
| 85 | }, | 93 | }, |
| @@ -91,8 +99,8 @@ module.exports = { | @@ -91,8 +99,8 @@ module.exports = { | ||
| 91 | // { text: '指南', link: '/zh/guide/' }, | 99 | // { text: '指南', link: '/zh/guide/' }, |
| 92 | // { text: '配置', link: '/zh/config/' }, | 100 | // { text: '配置', link: '/zh/config/' }, |
| 93 | // { text: 'API', link: '/zh/api/' }, | 101 | // { text: 'API', link: '/zh/api/' }, |
| 94 | - // { text: '插件', link: '/zh/plugin/' }, | ||
| 95 | { text: '首页', link: 'https://h5.luban-h5.com' }, | 102 | { text: '首页', link: 'https://h5.luban-h5.com' }, |
| 103 | + { text: '生态', link: '/zh/ecosystem/' }, | ||
| 96 | { text: '发布日志', link: 'https://github.com/ly525/luban-h5/releases' }, | 104 | { text: '发布日志', link: 'https://github.com/ly525/luban-h5/releases' }, |
| 97 | { text: '后端API文档', link: 'https://h5.luban-h5.com/documentation/' }, | 105 | { text: '后端API文档', link: 'https://h5.luban-h5.com/documentation/' }, |
| 98 | ], | 106 | ], |
| @@ -111,10 +119,9 @@ module.exports = { | @@ -111,10 +119,9 @@ module.exports = { | ||
| 111 | }, | 119 | }, |
| 112 | { | 120 | { |
| 113 | collapsable: false, | 121 | collapsable: false, |
| 114 | - title: '💡实现原理', | 122 | + title: '🤝社区生态-周边建设', |
| 115 | children: [ | 123 | children: [ |
| 116 | - '/zh/implementation/code-structure', | ||
| 117 | - '/zh/implementation/form-submit', | 124 | + '/zh/ecosystem/', |
| 118 | ], | 125 | ], |
| 119 | }, | 126 | }, |
| 120 | { | 127 | { |
| @@ -138,6 +145,14 @@ module.exports = { | @@ -138,6 +145,14 @@ module.exports = { | ||
| 138 | '/zh/migration-guide/', | 145 | '/zh/migration-guide/', |
| 139 | ], | 146 | ], |
| 140 | }, | 147 | }, |
| 148 | + { | ||
| 149 | + collapsable: false, | ||
| 150 | + title: '💡实现原理', | ||
| 151 | + children: [ | ||
| 152 | + '/zh/implementation/code-structure', | ||
| 153 | + '/zh/implementation/form-submit', | ||
| 154 | + ], | ||
| 155 | + }, | ||
| 141 | ], | 156 | ], |
| 142 | }, | 157 | }, |
| 143 | }, | 158 | }, |
docs/zh/ecosystem/README.md
0 → 100644
| 1 | +# 概览 | ||
| 2 | +一个开源项目的发展不单单靠这个项目本身,更多还取决于周边的生态建设。比如 jQuery 有众多插件,Vue 有 Awesome-Vue、React 有 Awesome-React,其强大的生态系统降低了大家上手使用的成本,避免了重复造轮子。 | ||
| 3 | + | ||
| 4 | +鲁班H5也希望向这些优秀的项目学习,构建自己的社区生态,让开发者能够借助社区的力量,更好的完成自己的需求。 | ||
| 5 | + | ||
| 6 | +## 鲁班H5生态建设 | ||
| 7 | +> WIP: working in progress/开发中 | ||
| 8 | + | ||
| 9 | +### 前端 | ||
| 10 | +1. 更多的营销组件(抽奖、滚动信息、地图等等) | ||
| 11 | + - 当鲁班提供的组件无法满足某些定制化的业务需求的时候,开发者可能需要开发适合实际业务的组件 | ||
| 12 | + - 我们提供了[组件开发脚手架](https://github.com/luban-h5/vue-cli-plugin-lbhc),用来辅助开发者进行快速开发组件。开发完成之后,可以发布到 npm 上,在鲁班后台做一些简单的配置,就可以使用自定义组件了 | ||
| 13 | + - 开发自定义组件,请参见 [***🔌插件/自定义组件开发*** ](/zh/plugin-development/)章节 | ||
| 14 | + | ||
| 15 | +2. [WIP]注入 JS 脚本,让页面拥有有和后端交互的能力。能做到: | ||
| 16 | + - 从后端请求数据 | ||
| 17 | + - 根据数据渲染页面 | ||
| 18 | + - 提交数据 | ||
| 19 | + - 打点统计等等 | ||
| 20 | + | ||
| 21 | + 更多讨论,参见[鲁班H5-Wiki [辅助篇] 自定义脚本](https://github.com/ly525/luban-h5/wiki/%5B%E8%BE%85%E5%8A%A9%E7%AF%87%5D-%E8%87%AA%E5%AE%9A%E4%B9%89%E8%84%9A%E6%9C%AC)。拥有了执行脚本的能力,就可以实现如下的H5页面了: | ||
| 22 | + 1. 千人千面 | ||
| 23 | + 2. 支付宝年度账单 | ||
| 24 | + 3. 网易云音乐年终总结 | ||
| 25 | + | ||
| 26 | + | ||
| 27 | +### 后端 | ||
| 28 | +目前鲁班H5的后端是基于 Node.js 写的,社区的很多小伙伴反馈,希望能够提供 Spring Boot 或者 PHP 等其它语言驱动的后端API。因为精力有限,我们提供了如下的解决方案,来尝试解决这个需求: | ||
| 29 | +1. 提供基于 Swagger UI 的后端API 文档,小伙伴只要参照参照 API 文档,使用 Spring Boot 或者 其它语言实现相同的API即可 | ||
| 30 | +2. 社区有小伙伴贡献了基于 Spring Boot 的API项目,如下,大家可以根据自己的需求,跟进这两个项目,非常欢迎提 PR 或 相关 issue: | ||
| 31 | + - [springboot2-jpa-api-for-luban](https://github.com/luban-h5/springboot2-jpa-api-for-luban)   | ||
| 32 | + - [springboot2-mybatis-plus-api-for-luban](https://github.com/luban-h5/springboot2-mybatis-plus-api-for-luban)   | ||
| 33 | + | ||
| 34 | +更多内容,请阅读 [LubanH5-Wiki](https://github.com/ly525/luban-h5/wiki) | ||
| 0 | \ No newline at end of file | 35 | \ No newline at end of file |