Commit 5372dfefeaeb4ff8a6fdffbcd8de003ba7a5b7e6
1 parent
a6de3a60
docs: update english doc url
Showing
10 changed files
with
21 additions
and
19 deletions
README.en.md
| @@ -2,7 +2,7 @@ | @@ -2,7 +2,7 @@ | ||
| 2 | <a href="https://github.com/ly525/luban-h5/releases"><img alt="GitHub release (latest by date)" src="https://img.shields.io/github/v/release/ly525/luban-h5"></a> | 2 | <a href="https://github.com/ly525/luban-h5/releases"><img alt="GitHub release (latest by date)" src="https://img.shields.io/github/v/release/ly525/luban-h5"></a> |
| 3 | </p> | 3 | </p> |
| 4 | 4 | ||
| 5 | -📖 [Online English Document](https://www.yuque.com/liuyan-ew1qk/oh5d0n?language=en-us) | [简体中文](./README.md) | 5 | +📖 [Online English Document](https://ly525.github.io/luban-h5/) | [简体中文](./README.md) |
| 6 | 6 | ||
| 7 | ### What's LuBan-H5? | 7 | ### What's LuBan-H5? |
| 8 | > LuBan-H5 is a mobile page builder based on Vue.js, which is similar with [Amolink](www.amolink.com) [eqx](http://www.eqxiu.com)(it's a chinese website, you may need to translate the page). It also supports parsing PSD file to HMTL5 Page | 8 | > LuBan-H5 is a mobile page builder based on Vue.js, which is similar with [Amolink](www.amolink.com) [eqx](http://www.eqxiu.com)(it's a chinese website, you may need to translate the page). It also supports parsing PSD file to HMTL5 Page |
| @@ -56,7 +56,7 @@ | @@ -56,7 +56,7 @@ | ||
| 56 | 56 | ||
| 57 | ### Installs | 57 | ### Installs |
| 58 | > proj: project root path | 58 | > proj: project root path |
| 59 | -please refer to: [`Document/Quick Start`](https://www.yuque.com/liuyan-ew1qk/oh5d0n/gpfy6g?language=en-us) | 59 | +please refer to: [`Document/Quick Start`](https://ly525.github.io/luban-h5/en/getting-started/quick-start.html?language=en-us) |
| 60 | 60 | ||
| 61 | 61 | ||
| 62 | --- | 62 | --- |
| @@ -71,4 +71,4 @@ please refer to: [`Document/Quick Start`](https://www.yuque.com/liuyan-ew1qk/oh5 | @@ -71,4 +71,4 @@ please refer to: [`Document/Quick Start`](https://www.yuque.com/liuyan-ew1qk/oh5 | ||
| 71 | 3. Storage: Sqlite | 71 | 3. Storage: Sqlite |
| 72 | 72 | ||
| 73 | 73 | ||
| 74 | -Read more here [Online English Document](https://www.yuque.com/liuyan-ew1qk/oh5d0n?language=en-us) | ||
| 75 | \ No newline at end of file | 74 | \ No newline at end of file |
| 75 | +Read more here [Online English Document](https://ly525.github.io/luban-h5) | ||
| 76 | \ No newline at end of file | 76 | \ No newline at end of file |
back-end/h5-api/README.md
| @@ -4,7 +4,7 @@ | @@ -4,7 +4,7 @@ | ||
| 4 | 4 | ||
| 5 | 5 | ||
| 6 | ## Getting Started(English) | 6 | ## Getting Started(English) |
| 7 | -<a href="https://www.yuque.com/liuyan-ew1qk/oh5d0n/gpfy6g" target="_blank">Read the Getting Started tutorial</a> | 7 | +<a href="https://ly525.github.io/luban-h5/en/getting-started/quick-start.html" target="_blank">Read the Getting Started tutorial</a> |
| 8 | 8 | ||
| 9 | ## 快速上手(中文) | 9 | ## 快速上手(中文) |
| 10 | <a href="https://ly525.github.io/luban-h5/zh/getting-started/quick-start.html" target="_blank">请阅读快速上手指南</a> | 10 | <a href="https://ly525.github.io/luban-h5/zh/getting-started/quick-start.html" target="_blank">请阅读快速上手指南</a> |
docs/.vuepress/config.js
| 1 | module.exports = { | 1 | module.exports = { |
| 2 | title: '鲁班H5', | 2 | title: '鲁班H5', |
| 3 | + base: '/luban-h5/', | ||
| 3 | locales: { | 4 | locales: { |
| 4 | '/': { | 5 | '/': { |
| 5 | lang: 'en-US', | 6 | lang: 'en-US', |
| @@ -17,6 +18,7 @@ module.exports = { | @@ -17,6 +18,7 @@ module.exports = { | ||
| 17 | lastUpdated: 'Last Updated', | 18 | lastUpdated: 'Last Updated', |
| 18 | editLinks: true, | 19 | editLinks: true, |
| 19 | docsDir: 'docs', | 20 | docsDir: 'docs', |
| 21 | + docsBranch: 'dev', | ||
| 20 | serviceWorker: { | 22 | serviceWorker: { |
| 21 | updatePopup: { | 23 | updatePopup: { |
| 22 | message: 'New content is available.', | 24 | message: 'New content is available.', |
docs/deploy.sh
docs/en/getting-started/features.md
| 1 | # Features | 1 | # Features |
| 2 | 2 | ||
| 3 | -### [](https://www.yuque.com/liuyan-ew1qk/oh5d0n/siwn9y?translate=en#53733cd6)Editor | 3 | +### Editor |
| 4 | - [x] Reference line | 4 | - [x] Reference line |
| 5 | - [x] Adsorption line, assembly alignment | 5 | - [x] Adsorption line, assembly alignment |
| 6 | - [x] Towing change component shape | 6 | - [x] Towing change component shape |
| @@ -14,9 +14,9 @@ | @@ -14,9 +14,9 @@ | ||
| 14 | - [x] Undo, redo | 14 | - [x] Undo, redo |
| 15 | 15 | ||
| 16 | 16 | ||
| 17 | -### [](https://www.yuque.com/liuyan-ew1qk/oh5d0n/siwn9y?translate=en#40fb9f22)Component System | 17 | +### Component System |
| 18 | 18 | ||
| 19 | -#### [](https://www.yuque.com/liuyan-ew1qk/oh5d0n/siwn9y?translate=en#GQa0Y)Basic component | 19 | +#### Basic component |
| 20 | 20 | ||
| 21 | - [x] Ordinary text | 21 | - [x] Ordinary text |
| 22 | - [x] Normal button | 22 | - [x] Normal button |
| @@ -25,7 +25,7 @@ | @@ -25,7 +25,7 @@ | ||
| 25 | - [ ] Video (Iframe form) | 25 | - [ ] Video (Iframe form) |
| 26 | 26 | ||
| 27 | 27 | ||
| 28 | -#### [](https://www.yuque.com/liuyan-ew1qk/oh5d0n/siwn9y?translate=en#Ibh4H)Form Component | 28 | +#### Form Component |
| 29 | 29 | ||
| 30 | - [x] Form button | 30 | - [x] Form button |
| 31 | - [x] Form input box | 31 | - [x] Form input box |
| @@ -34,7 +34,7 @@ | @@ -34,7 +34,7 @@ | ||
| 34 | 34 | ||
| 35 | 35 | ||
| 36 | 36 | ||
| 37 | -### [](https://www.yuque.com/liuyan-ew1qk/oh5d0n/siwn9y?translate=en#4uFaO)Enhancements [open source] | 37 | +### Enhancements [open source] |
| 38 | 38 | ||
| 39 | - [x] Template list | 39 | - [x] Template list |
| 40 | - [x] Making H5 based on template | 40 | - [x] Making H5 based on template |
| @@ -45,13 +45,13 @@ | @@ -45,13 +45,13 @@ | ||
| 45 | 45 | ||
| 46 | 46 | ||
| 47 | 47 | ||
| 48 | -### [](https://www.yuque.com/liuyan-ew1qk/oh5d0n/siwn9y?translate=en#kDYKy)Enhancements [may not open source] | 48 | +### Enhancements [may not open source] |
| 49 | > Has been investigated, can be realized, advanced functions, not yet open | 49 | > Has been investigated, can be realized, advanced functions, not yet open |
| 50 | 50 | ||
| 51 | - [x] Upload PSD, one-click conversion to H5 | 51 | - [x] Upload PSD, one-click conversion to H5 |
| 52 | - [x] Custom script | 52 | - [x] Custom script |
| 53 | 53 | ||
| 54 | -### [](https://www.yuque.com/liuyan-ew1qk/oh5d0n/siwn9y?translate=en#289dcb17)Backend API | 54 | +### Backend API |
| 55 | 55 | ||
| 56 | - [x] Create, save, and update works | 56 | - [x] Create, save, and update works |
| 57 | - [x] Form data collection | 57 | - [x] Form data collection |
docs/en/getting-started/introduction.md
| @@ -55,7 +55,7 @@ | @@ -55,7 +55,7 @@ | ||
| 55 | 55 | ||
| 56 | ### Installs | 56 | ### Installs |
| 57 | > proj: project root path | 57 | > proj: project root path |
| 58 | -please refer to: [`Document/Quick Start`](https://www.yuque.com/liuyan-ew1qk/oh5d0n/gpfy6g?language=en-us) | 58 | +please refer to: [`Document/Quick Start`](https://ly525.github.io/luban-h5/en/getting-started/quick-start.html?language=en-us) |
| 59 | 59 | ||
| 60 | 60 | ||
| 61 | --- | 61 | --- |
| @@ -70,7 +70,7 @@ please refer to: [`Document/Quick Start`](https://www.yuque.com/liuyan-ew1qk/oh5 | @@ -70,7 +70,7 @@ please refer to: [`Document/Quick Start`](https://www.yuque.com/liuyan-ew1qk/oh5 | ||
| 70 | 3. Storage: Sqlite | 70 | 3. Storage: Sqlite |
| 71 | 71 | ||
| 72 | 72 | ||
| 73 | -Read more here [Online English Document](https://www.yuque.com/liuyan-ew1qk/oh5d0n?language=en-us) | 73 | +Read more here [Online English Document](https://ly525.github.io/luban-h5) |
| 74 | 74 | ||
| 75 | --- | 75 | --- |
| 76 | 76 |
front-end/h5/README.md
| @@ -6,7 +6,7 @@ includes | @@ -6,7 +6,7 @@ includes | ||
| 6 | 4. preview module | 6 | 4. preview module |
| 7 | 7 | ||
| 8 | ## Getting Started | 8 | ## Getting Started |
| 9 | -<a href="https://www.yuque.com/liuyan-ew1qk/oh5d0n/gpfy6g" target="_blank">Read the Getting Started tutorial</a> | 9 | +<a href="https://ly525.github.io/luban-h5/en/getting-started/quick-start.html" target="_blank">Read the Getting Started tutorial</a> |
| 10 | 10 | ||
| 11 | 11 | ||
| 12 | ## 鲁班H5前端模块 | 12 | ## 鲁班H5前端模块 |
front-end/h5/src/components/common/header/links.js
| @@ -25,10 +25,10 @@ export default { | @@ -25,10 +25,10 @@ export default { | ||
| 25 | </a-menu-item> | 25 | </a-menu-item> |
| 26 | <a-menu-item key="document"> | 26 | <a-menu-item key="document"> |
| 27 | {/* <a href="https://ly525.github.io/luban-h5" target="_blank" rel="noopener" style={{ color: 'white' }}><a-icon type="read" />文档</a> */} | 27 | {/* <a href="https://ly525.github.io/luban-h5" target="_blank" rel="noopener" style={{ color: 'white' }}><a-icon type="read" />文档</a> */} |
| 28 | - <a href="https://ly525.github.io/luban-h5" target="_blank" rel="noopener" style={{ color: 'white' }}><a-icon type="read" />{this.$t('header.chineseDocument')}</a> | 28 | + <a href="https://ly525.github.io/luban-h5/zh/" target="_blank" rel="noopener" style={{ color: 'white' }}><a-icon type="read" />{this.$t('header.chineseDocument')}</a> |
| 29 | </a-menu-item> | 29 | </a-menu-item> |
| 30 | <a-menu-item key="document-en"> | 30 | <a-menu-item key="document-en"> |
| 31 | - <a href="https://www.yuque.com/liuyan-ew1qk/oh5d0n?language=en-us" target="_blank" rel="noopener" style={{ color: 'white' }}><a-icon type="read" />Document(En)</a> | 31 | + <a href="https://ly525.github.io/luban-h5" target="_blank" rel="noopener" style={{ color: 'white' }}><a-icon type="read" />Document(En)</a> |
| 32 | </a-menu-item> | 32 | </a-menu-item> |
| 33 | <a-menu-item key="gitee"> | 33 | <a-menu-item key="gitee"> |
| 34 | <a href="https://gitee.com/ly525/luban-h5" target="_blank" rel="noopener" style={{ color: 'white' }}>Gitee</a> | 34 | <a href="https://gitee.com/ly525/luban-h5" target="_blank" rel="noopener" style={{ color: 'white' }}>Gitee</a> |
front-end/landing-page/src/Index/data.js
| @@ -257,7 +257,7 @@ export const page4 = [ | @@ -257,7 +257,7 @@ export const page4 = [ | ||
| 257 | export const footer = [ | 257 | export const footer = [ |
| 258 | // { text: '解决方案', src: '#' }, | 258 | // { text: '解决方案', src: '#' }, |
| 259 | { text: '中文文档', src: 'https://ly525.github.io/luban-h5' }, | 259 | { text: '中文文档', src: 'https://ly525.github.io/luban-h5' }, |
| 260 | - { text: 'English Document', src: 'https://www.yuque.com/liuyan-ew1qk/oh5d0n?language=en-us' }, | 260 | + { text: 'English Document', src: 'https://ly525.github.io/luban-h5' }, |
| 261 | // { text: '模板开发文档', src: '#' }, | 261 | // { text: '模板开发文档', src: '#' }, |
| 262 | { text: '联系我们', src: 'https://github.com/ly525/luban-h5#%E4%BA%A4%E6%B5%81%E7%BE%A4' }, | 262 | { text: '联系我们', src: 'https://github.com/ly525/luban-h5#%E4%BA%A4%E6%B5%81%E7%BE%A4' }, |
| 263 | // { text: '联系我们', src: 'mailto:zhao.wuz@antfin.com' }, | 263 | // { text: '联系我们', src: 'mailto:zhao.wuz@antfin.com' }, |
front-end/landing-page/src/layouts/Nav0.jsx
| @@ -132,7 +132,7 @@ class Header extends React.Component { | @@ -132,7 +132,7 @@ class Header extends React.Component { | ||
| 132 | window.open('https://ly525.github.io/luban-h5/zh/') | 132 | window.open('https://ly525.github.io/luban-h5/zh/') |
| 133 | }}>中文文档</Menu.Item> | 133 | }}>中文文档</Menu.Item> |
| 134 | <Menu.Item key="setting:2" onClick={() => { | 134 | <Menu.Item key="setting:2" onClick={() => { |
| 135 | - window.open('https://www.yuque.com/liuyan-ew1qk/oh5d0n?language=en-us') | 135 | + window.open('https://ly525.github.io/luban-h5') |
| 136 | }}>English Doc</Menu.Item> | 136 | }}>English Doc</Menu.Item> |
| 137 | </Menu.ItemGroup> | 137 | </Menu.ItemGroup> |
| 138 | </SubMenu> | 138 | </SubMenu> |