m5/m5-docs
0
0
Fork 0
mirror of https://github.com/m5stack/m5-docs.git synced 2026-05-20 10:23:01 -07:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #31 from watson8544/master

Browse Source 
fixed a bug
This commit is contained in:
LiHuashen
2018-10-26 15:53:38 +08:00
committed by GitHub
parent 439841e45f 354db6308e
commit fc8ad6eb9d
16 changed files with 186 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+1 -1
View File
@@ -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!**
docs/README.md
-21
View File
@@ -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)
docs/en/product_documents.md
+10 -4
View File
@@ -26,6 +26,12 @@
| / | / | / |
| / | / | / |
<!-- <img src='assets/img/product_pics/5.jpg'> <img src='assets/img/product_pics/accessory.png'>
- [M5GO-Base](en/bases/cables/m5go_base)
- [PLC-Base](en/bases/plc_base)
- [FACE-Base](en/bases/faces_base)
- [LAN](en/bases/lan_base) -->
<img src='assets/img/product_pics/5.jpg'> <img src='assets/img/product_pics/accessory.png'>
@@ -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) | / | / |
docs/en/product_documents/bases/face_base.md
+3
View File
@@ -0,0 +1,3 @@
# FACE-Base
## (coming soon...)
docs/en/product_documents/bases/lan_base.md
+3
View File
@@ -0,0 +1,3 @@
# LAN
## (coming soon...)
docs/en/product_documents/bases/m5go_base.md
+3
View File
@@ -0,0 +1,3 @@
# M5GO-Base
## (coming soon...)
docs/en/product_documents/bases/plc_base.md
+3
View File
@@ -0,0 +1,3 @@
# PLC-Base
## (coming soon...)
docs/ja/README.md
+20 -11
View File
@@ -7,9 +7,11 @@
**M5Stackの世界へようこそ!**
<figure class="thumbnails">
?> **ヒント** アンダーラインが引かれた部分はリンクになっています。
<!-- <figure class="thumbnails">
<img src="assets/img/m5stack.png" alt="Screenshot of coverpage" title="Cover page">
</figure>
</figure> -->
## 製品紹介
@@ -21,19 +23,26 @@ M5Stack Coreモジュールは **ESP32** チップをベースに開発されて
私たちの目標は "**Stackable Board is Product(積んで形に)**"です。オフィシャルサイトは [こちら](www.m5stack.com)です。
<figure class="thumbnails">
<!-- <figure class="thumbnails">
<img src="assets/img/transport.gif" alt="Screenshot of coverpage" title="Cover page">
</figure>
</figure> -->
|<img src="assets/img/introduction_pics/product-documents.jpg"> | <img src="assets/img/introduction_pics/get-started.jpg"> | <img src="assets/img/introduction_pics/FAQ.jpg"> |
|:---:|:---:|:---:|
|[製品ドキュメント](/ja/product_documents) | [クイックスタート](/ja/quick_start) | [演習](/ja/practice)|
|<img src="assets/img/introduction_pics/product-documents.jpg"> | <img src="assets/img/introduction_pics/m5-awesome.jpg"> |
|:---:|:---:|
|[製品ドキュメント](ja/product_documents_ja) | [M5Stack 応用例](ja/m5stack_cases_ja) |
|<img src="assets/img/introduction_pics/m5-api-reference.jpg"> | <img src="assets/img/introduction_pics/m5-awesome.jpg"> | <img src="assets/img/introduction_pics/FAQ.jpg">|
|:---:|:---:|:---:|
|[API リファレンス](/ja/api_reference) | [M5Stack 応用例](/ja/m5stack_cases) | [FAQ](/ja/faq)|
|<img src="assets/img/introduction_pics/m5-api-reference.jpg"> | <img src="assets/img/introduction_pics/FAQ.jpg">|
|:---:|:---:|
|[API リファレンス](ja/api_reference_ja) | [よくある質問](ja/faq_ja)|
?> **ヒント** アンダーラインが引かれた部分はリンクになっています。
<!--
|<img src="https://github.com/m5stack/m5-docs/tree/master/docs/assets/img/introduction_pics/product-documents.jpg"> | <img src="https://github.com/m5stack/m5-docs/tree/master/docs/assets/img/introduction_pics/m5-awesome.jpg"> |
|:---:|:---:|
|[製品ドキュメント](ja/product_documents_ja) | [M5Stack 応用例](ja/m5stack_cases_ja) |
|<img src="https://github.com/m5stack/m5-docs/tree/master/docs/assets/img/introduction_pics/m5-api-reference.jpg"> | <img src="https://github.com/m5stack/m5-docs/tree/master/docs/assets/img/introduction_pics/FAQ.jpg">|
|:---:|:---:|
|[API リファレンス](ja/api_reference_ja) | [よくある質問](ja/faq_ja)| -->
## コンタクト&サポート
docs/ja/README_ja.md
+61
View File
@@ -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&amp;utm_medium=referral&amp;utm_content=watson8544/M5Stack-Documentation-docsify&amp;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)
<a class="github-button" href="https://github.com/watson8544/M5Stack-Documentation-docsify" data-icon="octicon-star" data-show-count="true" aria-label="Star watson8544/M5Stack-Documentation-docsify on GitHub">Star</a>
**M5Stackの世界へようこそ!**
?> **ヒント** アンダーラインが引かれた部分はリンクになっています。
<!-- <figure class="thumbnails">
<img src="assets/img/m5stack.png" alt="Screenshot of coverpage" title="Cover page">
</figure> -->
## 製品紹介
**M5Stackはモジュール積層型の開発デバイスです。M5Stackの名前はModuleのM、5x5cmサイズの5、積み重ねるを意味するStackからきています。**
**M5Stackは、開発の際の煩わしさやストレスを軽減し、あなたがあなた自身の新しい発明やアイデアを具現化することに集中出来るように設計されています。M5Stackはいくつかのセンサー、Wi-Fi、Bluetooth、スクリーン、電源を自身に備えており、従来のブレッドボードでの煩雑な配線作業を行わなくても、拡張モジュールを積み重ねたり、Groveコネクタを介して拡張ユニットを簡単に接続することが可能です。**
M5Stack Coreモジュールは **ESP32** チップをベースに開発されています。
私たちの目標は "**Stackable Board is Product(積んで形に)**"です。オフィシャルサイトは [こちら](www.m5stack.com)です。
<!-- <figure class="thumbnails">
<img src="assets/img/transport.gif" alt="Screenshot of coverpage" title="Cover page">
</figure> -->
|<img src="assets/img/introduction_pics/product-documents.jpg"> | <img src="assets/img/introduction_pics/m5-awesome.jpg"> |
|:---:|:---:|
|[製品ドキュメント](ja/product_documents_ja) | [M5Stack 応用例](ja/m5stack_cases_ja) |
|<img src="assets/img/introduction_pics/m5-api-reference.jpg"> | <img src="assets/img/introduction_pics/FAQ.jpg">|
|:---:|:---:|
|[API リファレンス](ja/api_reference_ja) | [よくある質問](ja/faq_ja)|
<!--
|<img src="https://github.com/m5stack/m5-docs/tree/master/docs/assets/img/introduction_pics/product-documents.jpg"> | <img src="https://github.com/m5stack/m5-docs/tree/master/docs/assets/img/introduction_pics/m5-awesome.jpg"> |
|:---:|:---:|
|[製品ドキュメント](ja/product_documents_ja) | [M5Stack 応用例](ja/m5stack_cases_ja) |
|<img src="https://github.com/m5stack/m5-docs/tree/master/docs/assets/img/introduction_pics/m5-api-reference.jpg"> | <img src="https://github.com/m5stack/m5-docs/tree/master/docs/assets/img/introduction_pics/FAQ.jpg">|
|:---:|:---:|
|[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))
<!-- GitHub Buttons -->
<script async defer src="https://buttons.github.io/buttons.js"></script>
docs/ja/_sidebar.md
-11
View File
@@ -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)
docs/ja/api_reference_ja.md
+1
View File
@@ -0,0 +1 @@
[LCD](api_reference/api_lcd)
docs/ja/m5stack_cases_ja.md
+5
View File
@@ -0,0 +1,5 @@
# M5Stack Cases
## STEM Education
## STEM Education
docs/zh_CN/README.md
+8
View File
@@ -36,6 +36,14 @@
|:---:|:---:|
|[API参考](zh_CN/api_reference_zh_CN) | [常见问题解答](zh_CN/faq_zh_CN)|
<!-- |<img src="https://github.com/m5stack/m5-docs/tree/master/docs/assets/img/introduction_pics/product-documents.jpg"> | <img src="https://github.com/m5stack/m5-docs/tree/master/docs/assets/img/introduction_pics/m5-awesome.jpg"> |
|:---:|:---:|
|[产品介绍](zh_CN/product_documents_zh_CN) | [M5Stack案例](zh_CN/m5stack_cases_zh_CN) |
|<img src="https://github.com/m5stack/m5-docs/tree/master/docs/assets/img/introduction_pics/m5-api-reference.jpg"> | <img src="https://github.com/m5stack/m5-docs/tree/master/docs/assets/img/introduction_pics/FAQ.jpg">|
|:---:|:---:|
|[API参考](zh_CN/api_reference_zh_CN) | [常见问题解答](zh_CN/faq_zh_CN)| -->
## 联系方式(Contact & Support)
docs/zh_CN/README_zh_CN.md
+62
View File
@@ -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&amp;utm_medium=referral&amp;utm_content=watson8544/M5Stack-Documentation-docsify&amp;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)
<a class="github-button" href="https://github.com/watson8544/M5Stack-Documentation-docsify" data-icon="octicon-star" data-show-count="true" aria-label="Star watson8544/M5Stack-Documentation-docsify on GitHub">Star</a>
?> **提示** 点击下划线的蓝色字体可以跳转到对应链接。
<!-- <figure class="thumbnails">
<img src="assets/img/m5stack.png" alt="Screenshot of coverpage" title="Cover page">
</figure> -->
## 介绍(Introduction)
**M5是以M5Core主控为核心的一系列可堆叠、模块化的电子产品。 M 代表可堆叠的模块，5 代表模块尺寸为5 * 5 cm大小。**
**M5Stack的理念就是为了摆脱新发明开发过程复杂的痛苦，希望让用户的创意更容易实现。M5Stack主控内置wifi、蓝牙、多种传感器和一个小屏幕，还有电源模块和其他拓展传感器模块，每个产品都是单独模块，从而避免了结合面包板在设计产品原型时需要很多杂乱导线相连的情况，所以在设计一个新功能的时候，仅仅需要在各种我们提供的拓展模块之上堆叠一个M5Stack主控或者用M5Stack主控通过GROVE导线外接相应unit传感器就能实现一个完整的产品。**
我们的全系列产品基本是以<mark>ESP</mark>芯片为主芯片。
我们希望"**堆叠即是产品**"。 这是我们的[官网](www.m5stack.com)。
<!--
<figure class="thumbnails">
<img src="assets/img/transport.gif" alt="Screenshot of coverpage" title="Cover page">
</figure> -->
|<img src="assets/img/introduction_pics/product-documents.jpg"> | <img src="assets/img/introduction_pics/m5-awesome.jpg"> |
|:---:|:---:|
|[产品介绍](zh_CN/product_documents_zh_CN) | [M5Stack案例](zh_CN/m5stack_cases_zh_CN) |
|<img src="assets/img/introduction_pics/m5-api-reference.jpg"> | <img src="assets/img/introduction_pics/FAQ.jpg">|
|:---:|:---:|
|[API参考](zh_CN/api_reference_zh_CN) | [常见问题解答](zh_CN/faq_zh_CN)|
<!-- |<img src="https://github.com/m5stack/m5-docs/tree/master/docs/assets/img/introduction_pics/product-documents.jpg"> | <img src="https://github.com/m5stack/m5-docs/tree/master/docs/assets/img/introduction_pics/m5-awesome.jpg"> |
|:---:|:---:|
|[产品介绍](zh_CN/product_documents_zh_CN) | [M5Stack案例](zh_CN/m5stack_cases_zh_CN) |
|<img src="https://github.com/m5stack/m5-docs/tree/master/docs/assets/img/introduction_pics/m5-api-reference.jpg"> | <img src="https://github.com/m5stack/m5-docs/tree/master/docs/assets/img/introduction_pics/FAQ.jpg">|
|:---:|:---:|
|[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))
<!-- GitHub Buttons -->
<script async defer src="https://buttons.github.io/buttons.js"></script>
docs/zh_CN/api_reference_zh_CN.md
+1
View File
@@ -0,0 +1 @@
[LCD](api_reference/api_lcd)
docs/zh_CN/m5stack_cases_zh_CN.md
+5
View File
@@ -0,0 +1,5 @@
# M5Stack Cases
## STEM Education
## STEM Education