From ec7d41373a34ef463ed864c166c368be82c033ec Mon Sep 17 00:00:00 2001 From: watson8544 <854410664@qq.com> Date: Fri, 26 Oct 2018 15:31:46 +0800 Subject: [PATCH 1/3] fixed a bug --- docs/en/product_documents.md | 14 ++++++++++---- docs/en/product_documents/bases/face_base.md | 3 +++ docs/en/product_documents/bases/lan_base.md | 3 +++ docs/en/product_documents/bases/m5go_base.md | 3 +++ docs/en/product_documents/bases/plc_base.md | 3 +++ 5 files changed, 22 insertions(+), 4 deletions(-) create mode 100644 docs/en/product_documents/bases/face_base.md create mode 100644 docs/en/product_documents/bases/lan_base.md create mode 100644 docs/en/product_documents/bases/m5go_base.md create mode 100644 docs/en/product_documents/bases/plc_base.md diff --git a/docs/en/product_documents.md b/docs/en/product_documents.md index e5216789..d3d520c8 100644 --- a/docs/en/product_documents.md +++ b/docs/en/product_documents.md @@ -26,6 +26,12 @@ | / | / | / | | / | / | / | + @@ -41,8 +47,8 @@ | [ENV](en/product_documents/units/unit_env) | [RGB](en/product_documents/units/unit_rgb) | [HUB](en/product_documents/units/unit_hub) | | [IR](en/product_documents/units/unit_ir) | [RELAY](en/product_documents/units/unit_relay) | [3.96PORT](en/product_documents/units/unit_396port) | | [PIR](en/product_documents/units/unit_pir) | [NeoPixel](en/product_documents/units/unit_neopixel) | / | -| [ANGLE](en/product_documents/units/unit_angle) | [ESP32Cam](en/product_documents/units/unit_esp32cam) | / | -| [EARTH/Moisture](en/product_documents/units/unit_moisture) | [M5Camera](en/product_documents/units/unit_m5camera) | / | +| [ANGLE](en/product_documents/units/unit_angle) | / | / | +| [EARTH/Moisture](en/product_documents/units/unit_moisture) | / | / | | [LIGHT](en/product_documents/units/unit_light) | / | / | | [MAKEY](en/product_documents/units/unit_makey) | / | / | | [BUTTON](en/product_documents/units/unit_button) | / | / | @@ -53,8 +59,8 @@ | [DAC](en/product_documents/units/unit_DAC) | / | / | | [Color Sensor](en/product_documents/units/unit_color_sensor) | / | / | | [ToF](en/product_documents/units/unit_tof) | / | / | - - +| [ESP32Cam](en/product_documents/units/unit_esp32cam) | / | / | +| [M5Camera](en/product_documents/units/unit_m5camera) | / | / | diff --git a/docs/en/product_documents/bases/face_base.md b/docs/en/product_documents/bases/face_base.md new file mode 100644 index 00000000..b07a0f96 --- /dev/null +++ b/docs/en/product_documents/bases/face_base.md @@ -0,0 +1,3 @@ +# FACE-Base + +## (coming soon...) \ No newline at end of file diff --git a/docs/en/product_documents/bases/lan_base.md b/docs/en/product_documents/bases/lan_base.md new file mode 100644 index 00000000..cf111f10 --- /dev/null +++ b/docs/en/product_documents/bases/lan_base.md @@ -0,0 +1,3 @@ +# LAN + +## (coming soon...) \ No newline at end of file diff --git a/docs/en/product_documents/bases/m5go_base.md b/docs/en/product_documents/bases/m5go_base.md new file mode 100644 index 00000000..76b615dc --- /dev/null +++ b/docs/en/product_documents/bases/m5go_base.md @@ -0,0 +1,3 @@ +# M5GO-Base + +## (coming soon...) \ No newline at end of file diff --git a/docs/en/product_documents/bases/plc_base.md b/docs/en/product_documents/bases/plc_base.md new file mode 100644 index 00000000..05afb952 --- /dev/null +++ b/docs/en/product_documents/bases/plc_base.md @@ -0,0 +1,3 @@ +# PLC-Base + +## (coming soon...) \ No newline at end of file From 85c97548ced3b549c10828c5df375a936c4ddf49 Mon Sep 17 00:00:00 2001 From: watson8544 <854410664@qq.com> Date: Fri, 26 Oct 2018 15:44:22 +0800 Subject: [PATCH 2/3] fixed a bug --- docs/ja/README.md | 24 ++++++++++++------------ docs/ja/_sidebar.md | 11 ----------- docs/ja/api_reference_ja.md | 1 + docs/ja/m5stack_cases_ja.md | 5 +++++ docs/zh_CN/README.md | 4 ++-- docs/zh_CN/api_reference_zh_CN.md | 1 + docs/zh_CN/m5stack_cases_zh_CN.md | 5 +++++ 7 files changed, 26 insertions(+), 25 deletions(-) delete mode 100644 docs/ja/_sidebar.md create mode 100644 docs/ja/api_reference_ja.md create mode 100644 docs/ja/m5stack_cases_ja.md create mode 100644 docs/zh_CN/api_reference_zh_CN.md create mode 100644 docs/zh_CN/m5stack_cases_zh_CN.md diff --git a/docs/ja/README.md b/docs/ja/README.md index eae635af..3624fdeb 100644 --- a/docs/ja/README.md +++ b/docs/ja/README.md @@ -7,9 +7,11 @@ **M5Stackの世界へようこそ!** -
+?> **ヒント** アンダーラインが引かれた部分はリンクになっています。 + + ## 製品紹介 @@ -21,19 +23,17 @@ M5Stack Coreモジュールは **ESP32** チップをベースに開発されて 私たちの目標は "**Stackable Board is Product(積んで形に)**"です。オフィシャルサイトは [こちら](www.m5stack.com)です。 -
+ -| | | | -|:---:|:---:|:---:| -|[製品ドキュメント](/ja/product_documents) | [クイックスタート](/ja/quick_start) | [演習](/ja/practice)| +| | | +|:---:|:---:| +|[製品ドキュメント](ja/product_documents_ja) | [M5Stack 応用例](ja/m5stack_cases_ja) | -| | | | -|:---:|:---:|:---:| -|[API リファレンス](/ja/api_reference) | [M5Stack 応用例](/ja/m5stack_cases) | [FAQ](/ja/faq)| - -?> **ヒント** アンダーラインが引かれた部分はリンクになっています。 +| | | +|:---:|:---:| +|[API リファレンス](ja/api_reference_ja) | [よくある質問](ja/faq_ja)| ## コンタクト&サポート diff --git a/docs/ja/_sidebar.md b/docs/ja/_sidebar.md deleted file mode 100644 index a0ff2e8b..00000000 --- a/docs/ja/_sidebar.md +++ /dev/null @@ -1,11 +0,0 @@ -- [イントロダクション](/ja/) -- [製品ドキュメント](/ja/product_documents.md) -- [クイックスタート](/ja/quick_start.md) -- [API リファレンス](/ja/api_reference.md) -- [M5Stack 応用例](/ja/m5stack_cases.md) -- [FAQ](/ja/faq.md) - - -- **Links** -- [![Github](https://icongram.jgog.in/simple/github.svg?color=808080&size=16)Github](https://github.com/m5stack/M5Stack) -- [![Twitter](https://icongram.jgog.in/simple/twitter.svg?colored&size=16)@M5Stack](http://twitter.com/M5Stack) diff --git a/docs/ja/api_reference_ja.md b/docs/ja/api_reference_ja.md new file mode 100644 index 00000000..a577e149 --- /dev/null +++ b/docs/ja/api_reference_ja.md @@ -0,0 +1 @@ +[LCD](api_reference/api_lcd) \ No newline at end of file diff --git a/docs/ja/m5stack_cases_ja.md b/docs/ja/m5stack_cases_ja.md new file mode 100644 index 00000000..d3ba65e2 --- /dev/null +++ b/docs/ja/m5stack_cases_ja.md @@ -0,0 +1,5 @@ +# M5Stack Cases + +## STEM Education + +## STEM Education diff --git a/docs/zh_CN/README.md b/docs/zh_CN/README.md index 11513968..2aaede47 100644 --- a/docs/zh_CN/README.md +++ b/docs/zh_CN/README.md @@ -28,11 +28,11 @@ Screenshot of coverpage
--> -| | | +| | | |:---:|:---:| |[产品介绍](zh_CN/product_documents_zh_CN) | [M5Stack案例](zh_CN/m5stack_cases_zh_CN) | -| | | +| | | |:---:|:---:| |[API参考](zh_CN/api_reference_zh_CN) | [常见问题解答](zh_CN/faq_zh_CN)| diff --git a/docs/zh_CN/api_reference_zh_CN.md b/docs/zh_CN/api_reference_zh_CN.md new file mode 100644 index 00000000..a577e149 --- /dev/null +++ b/docs/zh_CN/api_reference_zh_CN.md @@ -0,0 +1 @@ +[LCD](api_reference/api_lcd) \ No newline at end of file diff --git a/docs/zh_CN/m5stack_cases_zh_CN.md b/docs/zh_CN/m5stack_cases_zh_CN.md new file mode 100644 index 00000000..d3ba65e2 --- /dev/null +++ b/docs/zh_CN/m5stack_cases_zh_CN.md @@ -0,0 +1,5 @@ +# M5Stack Cases + +## STEM Education + +## STEM Education From 354db6308e43952e50024724b711442325a817b8 Mon Sep 17 00:00:00 2001 From: watson8544 <854410664@qq.com> Date: Fri, 26 Oct 2018 15:50:38 +0800 Subject: [PATCH 3/3] fixed a bug --- README.md | 2 +- docs/README.md | 21 ------------- docs/ja/README.md | 11 ++++++- docs/ja/README_ja.md | 61 +++++++++++++++++++++++++++++++++++++ docs/zh_CN/README.md | 12 ++++++-- docs/zh_CN/README_zh_CN.md | 62 ++++++++++++++++++++++++++++++++++++++ 6 files changed, 144 insertions(+), 25 deletions(-) delete mode 100644 docs/README.md create mode 100644 docs/ja/README_ja.md create mode 100644 docs/zh_CN/README_zh_CN.md diff --git a/README.md b/README.md index 51433e3a..d024c1f3 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # M5Stack -[中文](https://github.com/watson8544/m5stack-documentation/tree/master/docs/zh_CN/README.md) | English | [日本語](https://github.com/watson8544/m5stack-documentation/tree/master/docs/ja/README.md) +[中文](https://github.com/watson8544/m5stack-documentation/tree/master/docs/zh_CN/README_zh_CN.md) | English | [日本語](https://github.com/watson8544/m5stack-documentation/tree/master/docs/ja/README_ja.md) **Welcome to M5Stack Documents!** diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index d4025ee9..00000000 --- a/docs/README.md +++ /dev/null @@ -1,21 +0,0 @@ -# M5Stack - -**Welcome to M5Stack Documents!** - -## Introduction - -**M5 stack is a modular stackable development device. The M stands for Modular and 5 stands for the the units compact 5 x 5 cm size.** - -**The M5 stack aims to take the pain out of developing your new inventions and ideas. M5 stack comes packed with sensors, wifi, bluetooth, a screen and its own power supply which avoids the inconvenience of messy wires strewn across breadboards and adding new functionality is as simple as stacking it on top of one of the many expansion modules or plugging in a unit via the handy grove connectors.** - -Our a series of core boards are based on **ESP32** chip. - -Our aim is "**Stackable Board is Product**". Here's the [Official Website](http://www.m5stack.com) - - -## Contact & Support - -- :computer: Visit [Official Website](http://www.m5stack.com) for newest product -- :busts_in_silhouette: Sign in our [Forum](http://forum.m5stack.com) for more designs with M5Stack -- :mailbox_with_mail: If you have any questions, you can contact us by [Email](tech@m5stack.com) -- :convenience_store: If you want to get our products, access our [store](http://www.aliexpress.com/store/all-wholesale-products/3226069.html?spm=2114.12010108.100004.3.7e3a5379KoyhDo) diff --git a/docs/ja/README.md b/docs/ja/README.md index 3624fdeb..54bc10d1 100644 --- a/docs/ja/README.md +++ b/docs/ja/README.md @@ -27,13 +27,22 @@ M5Stack Coreモジュールは **ESP32** チップをベースに開発されて Screenshot of coverpage
--> +| | | +|:---:|:---:| +|[製品ドキュメント](ja/product_documents_ja) | [M5Stack 応用例](ja/m5stack_cases_ja) | + +| | | +|:---:|:---:| +|[API リファレンス](ja/api_reference_ja) | [よくある質問](ja/faq_ja)| + + ## コンタクト&サポート diff --git a/docs/ja/README_ja.md b/docs/ja/README_ja.md new file mode 100644 index 00000000..54bc10d1 --- /dev/null +++ b/docs/ja/README_ja.md @@ -0,0 +1,61 @@ +# M5Stack 公式ドキュメント + +[![Codacy grade](https://img.shields.io/codacy/grade/860d40719cbd4e0f91e145b87ec7c29a.svg?style=flat-square)](https://www.codacy.com/app/watson8544/M5Stack-Documentation-docsify?utm_source=github.com&utm_medium=referral&utm_content=watson8544/M5Stack-Documentation-docsify&utm_campaign=Badge_Grade) +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://github.com/watson8544/M5Stack-Documentation-docsify/blob/master/LICENSE) +[![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?url=https%3A%2F%2Fgithub.com%2Fjhildenbiddle%2Fdocsify-themeable&hashtags=css,docsify,developers,frontend) +Star + +**M5Stackの世界へようこそ!** + +?> **ヒント** アンダーラインが引かれた部分はリンクになっています。 + + + +## 製品紹介 + +**M5Stackはモジュール積層型の開発デバイスです。M5Stackの名前はModuleのM、5x5cmサイズの5、積み重ねるを意味するStackからきています。** + +**M5Stackは、開発の際の煩わしさやストレスを軽減し、あなたがあなた自身の新しい発明やアイデアを具現化することに集中出来るように設計されています。M5Stackはいくつかのセンサー、Wi-Fi、Bluetooth、スクリーン、電源を自身に備えており、従来のブレッドボードでの煩雑な配線作業を行わなくても、拡張モジュールを積み重ねたり、Groveコネクタを介して拡張ユニットを簡単に接続することが可能です。** + +M5Stack Coreモジュールは **ESP32** チップをベースに開発されています。 + +私たちの目標は "**Stackable Board is Product(積んで形に)**"です。オフィシャルサイトは [こちら](www.m5stack.com)です。 + + + +| | | +|:---:|:---:| +|[製品ドキュメント](ja/product_documents_ja) | [M5Stack 応用例](ja/m5stack_cases_ja) | + +| | | +|:---:|:---:| +|[API リファレンス](ja/api_reference_ja) | [よくある質問](ja/faq_ja)| + + + +## コンタクト&サポート + +- :computer: 最新情報は[公式サイト](http://www.m5stack.com)(英語) +- :busts_in_silhouette: [フォーラム](http://forum.m5stack.com)にサインインしてM5Stackの情報交換をしよう +- :mailbox_with_mail: 質問・疑問は[Email](mailto:tech@m5stack.com) +- :convenience_store: 日本からの購入は[スイッチサイエンス](https://www.switch-science.com/catalog/list/770/)さんより + +## ライセンス + +このプロジェクトのライセンスは[MIT license](https://github.com/watson8544/M5Stack-Documentation-docsify/blob/master/LICENSE)です。 + +Copyright (c) 2018 M5Stack ([@M5Stack](https://twitter.com/M5Stack)) + + + diff --git a/docs/zh_CN/README.md b/docs/zh_CN/README.md index 2aaede47..173f55c9 100644 --- a/docs/zh_CN/README.md +++ b/docs/zh_CN/README.md @@ -28,13 +28,21 @@ Screenshot of coverpage --> -| | | +| | | +|:---:|:---:| +|[产品介绍](zh_CN/product_documents_zh_CN) | [M5Stack案例](zh_CN/m5stack_cases_zh_CN) | + +| | | +|:---:|:---:| +|[API参考](zh_CN/api_reference_zh_CN) | [常见问题解答](zh_CN/faq_zh_CN)| + + ## 联系方式(Contact & Support) diff --git a/docs/zh_CN/README_zh_CN.md b/docs/zh_CN/README_zh_CN.md new file mode 100644 index 00000000..173f55c9 --- /dev/null +++ b/docs/zh_CN/README_zh_CN.md @@ -0,0 +1,62 @@ +# M5Stack + +**Welcome to M5Stack Documents!** + +[![Codacy grade](https://img.shields.io/codacy/grade/860d40719cbd4e0f91e145b87ec7c29a.svg?style=flat-square)](https://www.codacy.com/app/watson8544/M5Stack-Documentation-docsify?utm_source=github.com&utm_medium=referral&utm_content=watson8544/M5Stack-Documentation-docsify&utm_campaign=Badge_Grade) +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://github.com/watson8544/M5Stack-Documentation-docsify/blob/master/LICENSE) +[![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?url=https%3A%2F%2Fgithub.com%2Fjhildenbiddle%2Fdocsify-themeable&hashtags=css,docsify,developers,frontend) +Star + +?> **提示** 点击下划线的蓝色字体可以跳转到对应链接。 + + + +## 介绍(Introduction) + +**M5是以M5Core主控为核心的一系列可堆叠、模块化的电子产品。 M 代表可堆叠的模块，5 代表模块尺寸为5 * 5 cm大小。** + +**M5Stack的理念就是为了摆脱新发明开发过程复杂的痛苦，希望让用户的创意更容易实现。M5Stack主控内置wifi、蓝牙、多种传感器和一个小屏幕，还有电源模块和其他拓展传感器模块，每个产品都是单独模块，从而避免了结合面包板在设计产品原型时需要很多杂乱导线相连的情况，所以在设计一个新功能的时候，仅仅需要在各种我们提供的拓展模块之上堆叠一个M5Stack主控或者用M5Stack主控通过GROVE导线外接相应unit传感器就能实现一个完整的产品。** + +我们的全系列产品基本是以ESP芯片为主芯片。 + +我们希望"**堆叠即是产品**"。 这是我们的[官网](www.m5stack.com)。 + + + +| | | +|:---:|:---:| +|[产品介绍](zh_CN/product_documents_zh_CN) | [M5Stack案例](zh_CN/m5stack_cases_zh_CN) | + +| | | +|:---:|:---:| +|[API参考](zh_CN/api_reference_zh_CN) | [常见问题解答](zh_CN/faq_zh_CN)| + + + + +## 联系方式(Contact & Support) + +- :computer: 访问[官网](www.m5stack.com)了解最新的产品 +- :busts_in_silhouette: 登录我们的[论坛](http://forum.m5stack.com)了解更多基于M5产品的创意设计 +- :mailbox_with_mail: 如果你有对产品有任何疑问或有更好的建议，请联系我们的[邮箱](tech@m5stack.com) +- :convenience_store: 如果你想继续购买我们的产品，请访问我们的[官方旗舰店](http://www.aliexpress.com/store/all-wholesale-products/3226069.html?spm=2114.12010108.100004.3.7e3a5379KoyhDo) + +## License + +This project is licensed under the [MIT license](https://github.com/watson8544/M5Stack-Documentation-docsify/blob/master/LICENSE). + +Copyright (c) 2018 M5Stack ([@M5Stack](https://twitter.com/M5Stack)) + + +