From 389d15126640f9524dcd75c58e39125aabcf3008 Mon Sep 17 00:00:00 2001 From: Gitshaoxiang <1026025056@qq.com> Date: Thu, 28 May 2020 17:46:48 +0800 Subject: [PATCH] fix some bug --- docs/assets/js/custom.js | 4 +- docs/assets/js/custom.min.js | 2 +- docs/en/app/demo-board.md | 4 +- .../m5stack_core_get_started_MicroPython.md | 4 +- .../en/quick_start/unitv/unitv_quick_start.md | 39 ++++--------------- .../quick_start/unitv/unitv_quick_start.md | 39 ++++--------------- 6 files changed, 23 insertions(+), 69 deletions(-) diff --git a/docs/assets/js/custom.js b/docs/assets/js/custom.js index 079c86c8..d9f9ca1f 100644 --- a/docs/assets/js/custom.js +++ b/docs/assets/js/custom.js @@ -424,4 +424,6 @@ function creat_pdf() { $(".anchor-box").removeAttr("style"); $(".related_links").removeAttr("style"); $(".easyloader-box").removeAttr("style"); - } \ No newline at end of file + } + +$(document).on("keypress", "form", function(event) { return event.keyCode != 13;}); \ No newline at end of file diff --git a/docs/assets/js/custom.min.js b/docs/assets/js/custom.min.js index 9decbf86..45527ab2 100644 --- a/docs/assets/js/custom.min.js +++ b/docs/assets/js/custom.min.js @@ -1 +1 @@ -const description_icon='',purchase_icon='',example_icon='',video_icon='',quickstart_icon='',schematic_icon='',icon_list={EASYLOADER:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_logo/EASYLOADER_ICON.png",CORE:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_logo/CORE_ICON.png",MODULE:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_logo/MODULE_ICON.png",BASE:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_logo/BASE_ICON.png",UNIT:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_logo/UNIT_ICON.png",HAT:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_logo/HAT_ICON.png",ATOM:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_logo/ATOM_BASE_ICON.png",APPLICATION:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_logo/APPLICATION_ICON.png",ACCESSORY:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_logo/ACCESSORY_ICON.png",ALUMINIUM:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_logo/ALUMINIUM_ICON.png"};var Label1="",Label2='here is the anchor_name';function anchor_create(e,t){var c=window.location.href,n=Label1.replace(/here is the anchor_id/,t),o=Label2.replace(/here is the anchor_name/,e.toUpperCase());"DESCRIPTION"==e||"描述"==e?$(".anchor-box").append(n+description_icon+o):"EXAMPLE"==e||"案例程序"==e?$(".anchor-box").append(n+example_icon+o):"SCHEMATIC"==e||"原理图"==e?$(".anchor-box").append(n+schematic_icon+o):"VIDEO"==e||"相关视频"==e?$(".anchor-box").append(n+video_icon+o):icon_list.hasOwnProperty(e)?($(".anchor-box").append(n+""+o),"EASYLOADER"==e&&("#example_video".length>0&&$("#play-btn").on("click",function(e){e.stopPropagation(),$(".easyloader-mask").toggleClass("video_play"),$("#example_video")[0].play()}),$("#example_video").on("click",function(e){e.preventDefault(),$(".easyloader-mask").toggleClass("video_play"),$("#example_video")[0].pause()}))):-1==c.indexOf(/uiflow/)&&-1==c.indexOf(/arduino/)&&-1==c.indexOf(/quick_start/)&&-1==c.indexOf(/related_documents/)||$(".anchor-box").append(n+quickstart_icon+'"+e+"")}function anchor_search(e="none",t="none"){var c=window.location.href;if("/en/"==c.slice(-4)||"/zh_CN/"==c.slice(-7)||"/#/"==c.slice(-3)){$("#search_note").eq(0).after("
");var n=$(".product_page > div:gt(1)")}else{$("h2").eq(0).before("
");n=$("#main h2")}for(var o=0;o'+purchase_icon+''+a+""),"none"!=t&&$(".anchor-box").append("'+quickstart_icon+''+s+"")}function anchor_scroll(e,t,c){var n=window.location.href,o=$("#"+t).offset().top+$("#"+t).height()-$(window).scrollTop();if(o>100&&o<$("#"+t).height()+700)for(var a=0;a div:gt(1)");else c=$("#main h2");for(var n=0;n${c[o].textContent}`;if(-1!=kw_content.toLocaleLowerCase().indexOf(n)){var i=kw_content.toLocaleLowerCase().indexOf(n),l=function(){for(var e=i;e>=0;e--)if(" "==kw_content[e]||0==e)return e}(),r=function(){for(var e=i;e<=kw_content.length;e++)if(" "==kw_content[e]||e==kw_content.length)return e}(),h=kw_content.substring(0,l),p=kw_content.substring(r);a=`--${kw_content.substring(l,r)} ${h}${p}`}""!=n?$(".search_point").append(`${t[o].textContent+a+s}`):$(".item").parent().css("display","block")}else $(".item").eq(o).css("display","none"),$(".item").parent().children("p").css("display","none"),$(".item").eq(o).parent().next("hr").css("display","none")}function faq_search(e){$(".search-tips").css("display","block"),$(".faq-class").css("display","none");for(var t=$(".faq-item h5"),c=0;c0;)l.addImage(i,"JPEG",0,a,595.28,s),a-=841.89,(o-=n)>0&&l.addPage();var r=window.location.href,h=r.indexOf("#"),p=r.slice(h+2);l.save(p+".pdf")}}),$(".anchor-box").removeAttr("style"),$(".related_links").removeAttr("style"),$(".easyloader-box").removeAttr("style")}Input.focusin(function(){Input.animate({width:300}),$(".search_point").show(240)}),Input.focusout(function(){Input.animate({width:240}),setTimeout(function(){$(".search_point").hide(140)},160)}),$(document).ready(function(){$(".btn-toggle").on("click",function(){$(".btn-toggle").toggleClass("open"),$(".d-flex").toggleClass("open")})}),window.onhashchange=page_loading,page_loading(); \ No newline at end of file +const description_icon='',purchase_icon='',example_icon='',video_icon='',quickstart_icon='',schematic_icon='',icon_list={EASYLOADER:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_logo/EASYLOADER_ICON.png",CORE:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_logo/CORE_ICON.png",MODULE:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_logo/MODULE_ICON.png",BASE:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_logo/BASE_ICON.png",UNIT:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_logo/UNIT_ICON.png",HAT:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_logo/HAT_ICON.png",ATOM:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_logo/ATOM_BASE_ICON.png",APPLICATION:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_logo/APPLICATION_ICON.png",ACCESSORY:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_logo/ACCESSORY_ICON.png",ALUMINIUM:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_logo/ALUMINIUM_ICON.png"};var Label1="",Label2='here is the anchor_name';function anchor_create(e,t){var c=window.location.href,n=Label1.replace(/here is the anchor_id/,t),o=Label2.replace(/here is the anchor_name/,e.toUpperCase());"DESCRIPTION"==e||"描述"==e?$(".anchor-box").append(n+description_icon+o):"EXAMPLE"==e||"案例程序"==e?$(".anchor-box").append(n+example_icon+o):"SCHEMATIC"==e||"原理图"==e?$(".anchor-box").append(n+schematic_icon+o):"VIDEO"==e||"相关视频"==e?$(".anchor-box").append(n+video_icon+o):icon_list.hasOwnProperty(e)?($(".anchor-box").append(n+""+o),"EASYLOADER"==e&&("#example_video".length>0&&$("#play-btn").on("click",function(e){e.stopPropagation(),$(".easyloader-mask").toggleClass("video_play"),$("#example_video")[0].play()}),$("#example_video").on("click",function(e){e.preventDefault(),$(".easyloader-mask").toggleClass("video_play"),$("#example_video")[0].pause()}))):-1==c.indexOf(/uiflow/)&&-1==c.indexOf(/arduino/)&&-1==c.indexOf(/quick_start/)&&-1==c.indexOf(/related_documents/)||$(".anchor-box").append(n+quickstart_icon+'"+e+"")}function anchor_search(e="none",t="none"){var c=window.location.href;if("/en/"==c.slice(-4)||"/zh_CN/"==c.slice(-7)||"/#/"==c.slice(-3)){$("#search_note").eq(0).after("
");var n=$(".product_page > div:gt(1)")}else{$("h2").eq(0).before("
");n=$("#main h2")}for(var o=0;o'+purchase_icon+''+a+""),"none"!=t&&$(".anchor-box").append("'+quickstart_icon+''+s+"")}function anchor_scroll(e,t,c){var n=window.location.href,o=$("#"+t).offset().top+$("#"+t).height()-$(window).scrollTop();if(o>100&&o<$("#"+t).height()+700)for(var a=0;a div:gt(1)");else c=$("#main h2");for(var n=0;n${c[o].textContent}`;if(-1!=kw_content.toLocaleLowerCase().indexOf(n)){var i=kw_content.toLocaleLowerCase().indexOf(n),l=function(){for(var e=i;e>=0;e--)if(" "==kw_content[e]||0==e)return e}(),r=function(){for(var e=i;e<=kw_content.length;e++)if(" "==kw_content[e]||e==kw_content.length)return e}(),h=kw_content.substring(0,l),p=kw_content.substring(r);a=`--${kw_content.substring(l,r)} ${h}${p}`}""!=n?$(".search_point").append(`${t[o].textContent+a+s}`):$(".item").parent().css("display","block")}else $(".item").eq(o).css("display","none"),$(".item").parent().children("p").css("display","none"),$(".item").eq(o).parent().next("hr").css("display","none")}function faq_search(e){$(".search-tips").css("display","block"),$(".faq-class").css("display","none");for(var t=$(".faq-item h5"),c=0;c0;)l.addImage(i,"JPEG",0,a,595.28,s),a-=841.89,(o-=n)>0&&l.addPage();var r=window.location.href,h=r.indexOf("#"),p=r.slice(h+2);l.save(p+".pdf")}}),$(".anchor-box").removeAttr("style"),$(".related_links").removeAttr("style"),$(".easyloader-box").removeAttr("style")}Input.focusin(function(){Input.animate({width:300}),$(".search_point").show(240)}),Input.focusout(function(){Input.animate({width:240}),setTimeout(function(){$(".search_point").hide(140)},160)}),$(document).ready(function(){$(".btn-toggle").on("click",function(){$(".btn-toggle").toggleClass("open"),$(".d-flex").toggleClass("open")})}),window.onhashchange=page_loading,page_loading();$(document).on("keypress", "form", function(event) { return event.keyCode != 13;}); \ No newline at end of file diff --git a/docs/en/app/demo-board.md b/docs/en/app/demo-board.md index dbd2a9b9..32622655 100644 --- a/docs/en/app/demo-board.md +++ b/docs/en/app/demo-board.md @@ -133,7 +133,9 @@ var purchase_link = 'https://m5stack.com/collections/m5-application/products/iot-learning-kit'; - anchor_search(purchase_link); + var quickstart_link = 'https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/Demo-Board_en.pdf'; + + anchor_search(purchase_link,quickstart_link); scrollFunc(); \ No newline at end of file diff --git a/docs/en/quick_start/m5core/m5stack_core_get_started_MicroPython.md b/docs/en/quick_start/m5core/m5stack_core_get_started_MicroPython.md index 7e50091d..0c7c8b62 100644 --- a/docs/en/quick_start/m5core/m5stack_core_get_started_MicroPython.md +++ b/docs/en/quick_start/m5core/m5stack_core_get_started_MicroPython.md @@ -176,9 +176,9 @@ ified developers -!> Using UIFlow Desktop IDE requires M5 device with UIFlow firmware and enter ** USB programming mode **. +!> Using UIFlow Desktop IDE requires M5 device with UIFlow firmware and enter **USB programming mode**. -> Click the power button on the left side of the device to restart. Quickly select Setup after entering the menu, enter the configuration page, and select ** USB mode **. +> Click the power button on the left side of the device to restart. Quickly select Setup after entering the menu, enter the configuration page, and select **USB mode**. diff --git a/docs/en/quick_start/unitv/unitv_quick_start.md b/docs/en/quick_start/unitv/unitv_quick_start.md index b4dfb2eb..bf8cd901 100644 --- a/docs/en/quick_start/unitv/unitv_quick_start.md +++ b/docs/en/quick_start/unitv/unitv_quick_start.md @@ -1,22 +1,5 @@ # UnitV Quick Start {docsify-ignore-all} -## CONTENT - -**[1. Download Firmware](#Download)** - -**[2. Flash Firmware](#Flash)** - -**[3. Serial Debugging Tool](#Serial-Tool)** - -**[5. Edit and Run the Code](#Edit-and-Run-the-Code)** - -**[5. MaixPy IDE](#MaixPy-IDE)** - -**[6. V-Training](#V-Training)** - -**[7. Library](#Library)** - - ## EasyLoader @@ -28,15 +11,13 @@ >2.After downloading the software, double-click to run the application, connect the M5 device to the computer via the data cable, select the port parameters, and click **"Burn"** to start burning. -## Download +## Firmware > Users who use an operating system other than Windows or who need to specify a burning file can use **Kflash** for firmware burning. Click the link below to download the firmware. -## Flash - >1. Flash tool Kflash_GUI.
@@ -68,10 +49,10 @@ ### Kflash ->3.对于习惯使用命令行操作的用户来说还可以选择Kflash作为固件烧录工具.[点击此处查看详情](https://github.com/kendryte/kflash.py) +> 3. For users who are used to command line operation, [can also choose Kflash as the firmware burning tool.](https://github.com/kendryte/kflash.py) -## Serial-Tool +### Serial-Tool >1. You will need a serial debugging tool for programming M5StickV, you can use Putty [in here](https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html),for download and information. @@ -300,13 +281,7 @@ In the library documentation, you can find more APIs to help you build a variety - - \ No newline at end of file + diff --git a/docs/zh_CN/quick_start/unitv/unitv_quick_start.md b/docs/zh_CN/quick_start/unitv/unitv_quick_start.md index 2fc07085..d7f5d406 100644 --- a/docs/zh_CN/quick_start/unitv/unitv_quick_start.md +++ b/docs/zh_CN/quick_start/unitv/unitv_quick_start.md @@ -1,21 +1,5 @@ # UnitV 上手指南 {docsify-ignore-all} -## 目录 - -**[1. 下载固件](#下载固件)** - -**[2. 烧录固件](#烧录固件)** - -**[3. 串口调试工具](#串口调试工具)** - -**[4. 编辑与运行文件](#编辑与运行文件)** - -**[5. MaixPy IDE](#MaixPy-IDE)** - -**[6. V-Training](#V-Training)** - -**[7. 程序库](#程序库)** - ## EasyLoader @@ -28,15 +12,13 @@ >2.下载软件后，双击运行应用程序，将M5设备通过数据线连接至电脑,选择端口参数，点击 **"Burn"** 即可开始烧录 -## 下载固件 +## 固件烧录 -> 需要指定烧录文件的用户可以选用**Kflash**进行固件烧录. +> 需要指定烧录文件的用户也可以选用**Kflash**进行固件烧录. -## 烧录固件 - >1.点击下方对应自己操作系统的 Kflash_GUI烧录工具进行下载.
@@ -71,7 +53,7 @@ >3.对于习惯使用命令行操作的用户来说还可以选择Kflash作为固件烧录工具.[点击此处查看详情](https://github.com/kendryte/kflash.py) -## 串口调试工具 +### 串口调试工具 >1.编程UnitV需要使用到串口调试工具，您可以使用Putty作为串口调试工具, [点击此处](https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html)访问Putty资源页面，选择对应自己操作系统Putty进行下载，并安装. @@ -297,14 +279,7 @@ while True: - - - \ No newline at end of file +