diff --git a/README.md b/README.md index 9dd380bd..fee83731 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # M5Stack -[中文](docs/README_cn.md) | English | [日本語](docs/README_jp.md) +[中文](docs/zh-cn/README.md) | English | [日本語](docs/ja/README.md) **Welcome to M5Stack Documents!** diff --git a/docs/README.md b/docs/README.md index d4025ee9..3755666d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,9 +1,11 @@ # M5Stack -**Welcome to M5Stack Documents!** +**welcome to M5Stack documents!** ## Introduction +**M5Stack + **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.** diff --git a/docs/README_jp.md b/docs/README_jp.md deleted file mode 100644 index 446cbb90..00000000 --- a/docs/README_jp.md +++ /dev/null @@ -1,3 +0,0 @@ -# よくある質問 - -## (近日公開...) \ No newline at end of file diff --git a/docs/_navbar.md b/docs/_navbar.md index 7f7de872..4efc315e 100644 --- a/docs/_navbar.md +++ b/docs/_navbar.md @@ -1,3 +1,3 @@ -- [中文](/cn/) +- [中文](/zh-cn/) - [En](/) -- [日本語](/jp/) \ No newline at end of file +- [日本語](/ja/) \ No newline at end of file diff --git a/docs/sidebar.md b/docs/_sidebar.md similarity index 93% rename from docs/sidebar.md rename to docs/_sidebar.md index 86d05535..4697e507 100644 --- a/docs/sidebar.md +++ b/docs/_sidebar.md @@ -1,10 +1,11 @@ -- [Introduction](README.md) +- [Introduction](README) - [Product Documents](product_documents) - [Quick Start](quick_start) - [API Rreference](api_reference) - [M5Stack Cases](m5stack_cases) - [FAQ](faq) + - **Links** - [![Github](https://icongram.jgog.in/simple/github.svg?color=808080&size=16)Github](https://github.com/watson8544/M5Stack-Documentation-docsify) - [![Twitter](https://icongram.jgog.in/simple/twitter.svg?colored&size=16)@M5Stack](http://twitter.com/M5Stack) diff --git a/docs/faq_jp.md b/docs/faq_jp.md deleted file mode 100644 index 411c6723..00000000 --- a/docs/faq_jp.md +++ /dev/null @@ -1,5 +0,0 @@ -# M5Stack - -[中文](docs/README_cn.md) | [English](docs/README.md) | 日本語 - -## (近日公開...) \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 1c2a0dee..d03a279d 100644 --- a/docs/index.html +++ b/docs/index.html @@ -19,6 +19,9 @@ +
@@ -31,9 +34,10 @@ coverpage : 'coverpage.md', homepage : 'index.md', loadNavbar : '_navbar.md', - loadSidebar: 'sidebar.md', + loadSidebar: '_sidebar.md', nameLink: { - '/cn/': '#/cn/', + '/cn/': '#/zh-cn/', + '/ja/': '#/ja/', '/': '#/' }, diff --git a/docs/ja/README.md b/docs/ja/README.md new file mode 100644 index 00000000..0c8917d2 --- /dev/null +++ b/docs/ja/README.md @@ -0,0 +1,52 @@ +# 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の世界へようこそ!** + +
+ Screenshot of coverpage +
+ +## 製品紹介 + +**M5Stackはモジュール積層型の開発デバイスです。M5Stackの名前はModuleの「M」、5x5cmサイズの「5」、”積み重ねる”を意味する「Stack」からきています。** + +**M5Stackは、開発の際の煩わしさやストレスを軽減し、あなたがあなた自身の新しい発明やアイデアを具現化することに集中出来るように設計されています。M5Stackはいくつかのセンサー、Wi-Fi、Bluetooth、スクリーン、電源を自身に備えており、従来のブレッドボードでの煩雑な配線作業を行わなくても、拡張モジュールを積み重ねたり、Groveコネクタを介して拡張ユニットを簡単に接続することが可能です。** + +M5Stack Coreモジュールは **ESP32** チップをベースに開発されています。 + +私たちの目標は "**Stackable Board is Product(積んで形に)**"です。オフィシャルサイトは [こちら](www.m5stack.com)です。 + +
+ Screenshot of coverpage +
+ +| | | | +|:---:|:---:|:---:| +|[製品ドキュメント](/ja/product_documents) | [クイックスタート](/ja/quick_start) | [演習](/ja/practice)| + +| | | | +|:---:|:---:|:---:| +|[API リファレンス](/ja/api_reference) | [M5Stack 応用例](/ja/m5stack_cases) | [FAQ](/ja/faq)| + +?> **ヒント** アンダーラインが引かれた部分はリンクになっています。 + +## コンタクト&サポート + +- :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/ja/_404.md b/docs/ja/_404.md new file mode 100644 index 00000000..0c0129e8 --- /dev/null +++ b/docs/ja/_404.md @@ -0,0 +1 @@ +404 - ファイルが見つかりません diff --git a/docs/ja/_sidebar.md b/docs/ja/_sidebar.md new file mode 100644 index 00000000..a0ff2e8b --- /dev/null +++ b/docs/ja/_sidebar.md @@ -0,0 +1,11 @@ +- [イントロダクション](/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.md b/docs/ja/api_reference.md new file mode 100644 index 00000000..10fab6b4 --- /dev/null +++ b/docs/ja/api_reference.md @@ -0,0 +1,3 @@ +# API リファレンス + +## 近日公開... diff --git a/docs/ja/faq.md b/docs/ja/faq.md new file mode 100644 index 00000000..be5d3b01 --- /dev/null +++ b/docs/ja/faq.md @@ -0,0 +1,5 @@ +# FAQ（よくある質問） + +[中文](/zh-cn/faq.md) | [English](/faq.md) | 日本語 + +## (近日公開...) diff --git a/docs/ja/m5stack_cases.md b/docs/ja/m5stack_cases.md new file mode 100644 index 00000000..996aa145 --- /dev/null +++ b/docs/ja/m5stack_cases.md @@ -0,0 +1,3 @@ +# M5Stack 応用例 + +## 近日公開... diff --git a/docs/ja/practice.md b/docs/ja/practice.md new file mode 100644 index 00000000..4bf36726 --- /dev/null +++ b/docs/ja/practice.md @@ -0,0 +1,5 @@ +# 演習 + + | | +---|---|--- +[M5StackCore](establish_serial_connection) | [M5Camera](establish_serial_connection) | [M5BALA](establish_serial_connection) diff --git a/docs/ja/product_documents.md b/docs/ja/product_documents.md new file mode 100644 index 00000000..2fa22082 --- /dev/null +++ b/docs/ja/product_documents.md @@ -0,0 +1,66 @@ +# 製品ドキュメント + + + +| M5Core | MiniCore | +| :----------: |:------------: | +| [BASIC](product_documents/m5stack-core/m5core_basic) | [Stick](minicore_stick) | +| [GRAY](product_documents/m5stack-core/m5core_gray) | / | +| [FIRE](product_documents/m5stack-core/m5core_fire) | / | + + + + + +| Wireless Modules | Accessory Modules | Controlling Modules | +| :------------------: |:------------------:| :--------------------:| +| [GPS](product_documents/modules/module_gps) | [PROTO](product_documents/modules/module_proto) | [STEPMOTOR](product_documents/modules/module_stepmotor)| +| [LORA](product_documents/modules/module_lora) | [BATTERY](product_documents/modules/module_battery) | [PLC](product_documents/modules/module_plc) | +| [LAN](product_documents/modules/module_lan) | [BTC](product_documents/modules/module_btc) | [FACES](product_documents/modules/module_face) | +| [SIM800/GPRS/GSM](product_documents/modules/module_sim800) | [PLUS](product_documents/modules/module_plus) | / | +| / | / | / | +| / | / | / | +| / | / | / | +| / | / | / | +| / | / | / | + + + + +- [LEGO-CABLE](product_documents/cables/accessory_lego_cable) +- [FRAME](product_documents/accessory_frame) + + + + + +| Input/Sensing Class | Output/Controlling Class | Interface Class | +| :-------------------: |:------------------------: | :----------------:| +| [ENV](product_documents/units/unit_env) | [RGB](product_documents/units/unit_rgb) | [HUB](product_documents/units/unit_hub) | +| [IR](product_documents/units/unit_ir) | [RELAY](product_documents/units/unit_relay) | [3.96PORT](product_documents/units/unit_396port) | +| [PIR](product_documents/units/unit_pir) | [NeoPixel](product_documents/units/unit_neopixel) | / | +| [ANGLE](product_documents/units/unit_angle) | [ESP32Cam](product_documents/units/unit_esp32cam) | / | +| [EARTH/Moisture](product_documents/units/unit_moisture) | [M5Camera](product_documents/units/unit_m5camera) | / | +| [LIGHT](product_documents/units/unit_light) | / | / | +| [MAKEY](product_documents/units/unit_makey) | / | / | +| [BUTTON](product_documents/units/unit_button) | / | / | +| [Dual-BUTTON](product_documents/units/unit_dual_button) | / | / | +| [JOYSTICK](product_documents/units/unit_joystick) | / | / | +| [THERMAL](product_documents/units/unit_thermal) | / | / | +| [ADC](product_documents/units/unit_ADC) | / | / | +| [DAC](product_documents/units/unit_DAC) | / | / | +| [Color Sensor](product_documents/units/unit_color_sensor) | / | / | +| [ToF](product_documents/units/unit_tof) | / | / | + + + + + + + +- [BALA](product_documents/applications/application_bala) + + + + +- [M5Stack USB Downloader](product_documents/tools/tool_usb_downloader) diff --git a/docs/ja/quick_start.md b/docs/ja/quick_start.md new file mode 100644 index 00000000..e7c28ccb --- /dev/null +++ b/docs/ja/quick_start.md @@ -0,0 +1,49 @@ +# クイックスタート + +**M5Stackの統合開発環境(IDE)のセットアップ、ファームウェア書込み、基本的な開発方法（Arduino,MicroPython）などを簡単な例を通して学んでいきましょう。** + +## はじめに + +**M5Stackはモジュール積層型の開発デバイスです。M5Stackの名前はModuleの「M」、5x5cmサイズの「5」、"積み重ねる"を意味する「Stack」からきています。** + +## 開発に必要なもの + +M5Stack アプリケーション開発に必要なもの: + +* Windows、Linux、MacいずれかのOSがインストールされた **PC** +* **USB Type-C** ケーブル + +事前準備: + +1. シリアル通信用USBドライバをインストールします。 + + [How to Establish serial connection](related_documents\establish_serial_connection) を参考にして、自分のPCに合ったドライバをインストールします。 + +## クイックスタート + +!> **注意** シリアル通信用USBドライバがインストール済みか確認してください。もしまだの場合は [How to Establish serial connection](related_documents\establish_serial_connection) を参考に、インストールを完了させてから次のステップに進んでください。 + +まずはじめにM5Stack本体にファームウェア(拡張子.bin)と呼ばれるファイルを書き込みます。やり方は [How to burn firmware](related_documents\how_to_burn_firmware_en.md) を参照してください。 + +もし以下の製品をお持ちの場合は、その製品のリンクをクリックして開発を始めましょう！ + + | | +---|---|--- +[M5StackCore](quick_start/m5core/m5stack_core_quick_start) | [M5Camera](quick_start/m5camera/m5camera_quick_start) | [M5BALA](quick_start/bala/bala_quick_start) + + + +## 演習 + +**次の中から、あなたの好きな言語を選んで、もっと練習してみよう！** + + | | +---|---|--- +[Arduino](practice\practice_arduino) | [M5Flow-Blockly](practice\practice_blockly) | [M5Flow-MicroPython](practice\practice_micropython) + +## 関連ドキュメント + + - [establish_serial_connection](related_documents/establish_serial_connection) + - [how_to_burn_firmware_en](related_documents/how_to_burn_firmware_en) + - [how_to_connect_wifi_using_core](related_documents/how_to_connect_wifi_using_core) + - [upgrade_m5stack_lib](related_documents/upgrade_m5stack_lib) diff --git a/docs/m5stack_cases.md b/docs/m5stack_cases.md index d3ba65e2..461ab54c 100644 --- a/docs/m5stack_cases.md +++ b/docs/m5stack_cases.md @@ -3,3 +3,4 @@ ## STEM Education ## STEM Education + diff --git a/docs/navbar.md b/docs/navbar.md deleted file mode 100644 index 325e0f93..00000000 --- a/docs/navbar.md +++ /dev/null @@ -1,3 +0,0 @@ -- [中文](/cn/) -- [En](/) -- [日本語](/jp/) diff --git a/docs/test/index.html b/docs/test/index.html deleted file mode 100644 index cba3566d..00000000 --- a/docs/test/index.html +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - docsify-themeable (Test) - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - diff --git a/docs/test/index.md b/docs/test/index.md deleted file mode 100644 index 4fd78f01..00000000 --- a/docs/test/index.md +++ /dev/null @@ -1,1069 +0,0 @@ -# Markdown - -## Headings - -# Heading 1 {docsify-ignore} - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse luctus nulla eu ex varius, a varius elit tincidunt. Aenean arcu magna, gravida id purus a, interdum convallis turpis. Aenean id ipsum eu tortor sollicitudin scelerisque in quis elit. - -## Heading 2 {docsify-ignore} - -Vestibulum lobortis laoreet nunc vel vulputate. In et augue non lectus pellentesque molestie et ac justo. Sed sed turpis ut diam gravida sagittis nec at neque. Vivamus id tellus est. Nam ac dignissim mi. Vestibulum nec sem convallis, condimentum augue at, commodo diam. - -### Heading 3 {docsify-ignore} - -Suspendisse sit amet tincidunt nibh, ac interdum velit. Ut orci diam, dignissim at enim sit amet, placerat rutrum magna. Mauris consectetur nibh eget sem feugiat, sit amet congue quam laoreet. Curabitur sed massa metus. - -#### Heading 4 {docsify-ignore} - -Donec odio orci, facilisis ac vehicula in, vestibulum ut urna. Ut bibendum ullamcorper risus, ac euismod leo maximus sed. In pulvinar sagittis rutrum. Morbi quis cursus diam. Cras ac laoreet nulla, rhoncus sodales dui. - -## Text - -Body text - -**Bold text** - -*Italic text* - -~~Strikethrough~~ - -Marked text - -
Preformatted text
- -Small Text - -This is subscript - -This is superscript - -## Links - -[Inline link](https://google.com) - -[Inline link with title](https://google.com "Google") - -[Reference link by name][link1] - -[Reference link by number][1] - -[Reference link by self] - -[link1]: https://google.com -[1]: https://google.com -[Reference link by self]: https://google.com - -## Lists - -**Unordered Lists** - -- Unordered 1 -- Unordered 2 -- Unordered 3 - - Unordered 3-1 - - Unordered 3-2 - - Unordered 3-3 - -**Ordered Lists** - -1. Ordered 1 -1. Ordered 2 -1. Ordered 3 - 1. Ordered 3-1 - 1. Ordered 3-2 - 1. Ordered 3-3 - -## Blockquotes - -> Cras aliquet nulla quis metus tincidunt, sed placerat enim cursus. Etiam -> turpis nisl, posuere eu condimentum ut, interdum a risus. Sed non luctus mi. -> Quisque malesuada risus sit amet tortor aliquet, a posuere ex iaculis. Vivamus -> ultrices enim dui, eleifend porttitor elit aliquet sed. -> -> *- Quote Source* - -## Notices - -!> Important with `inline code` - -?> Tip with `inline code` - -## Code - -This is `inline code` - -```javascript -const foo = 1; -const bar = 2; -const add = (num1, num2) => num1 + num2; - -console.log(add(foo, bar)); -``` - -```html - -

Hello

- -``` - -## Tables - -| Left Align | Center Align | Right Align | Non‑Breaking Header | -| ---------- |:------------:| -----------:| ------------------------------ | -| A1 | A2 | A3 | A4 | -| B1 | B2 | B3 | B4 | -| C1 | C2 | C3 | C4 | - -## Images - -Inline-style - -![alt text](//source.unsplash.com/collection/181581 "Provided by unsplash.com") - -Reference-style - -![alt text][logo] - -[logo]: //source.unsplash.com/collection/881815 "Provided by unsplash.com" - -## Emoji - -A complete list is available here: [Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet/) - -**People** - -:bowtie: -:smile: -:laughing: -:blush: -:smiley: -:relaxed: -:smirk: -:heart_eyes: -:kissing_heart: -:kissing_closed_eyes: -:flushed: -:relieved: -:satisfied: -:grin: -:wink: -:stuck_out_tongue_winking_eye: -:stuck_out_tongue_closed_eyes: -:grinning: -:kissing: -:kissing_smiling_eyes: -:stuck_out_tongue: -:sleeping: -:worried: -:frowning: -:anguished: -:open_mouth: -:grimacing: -:confused: -:hushed: -:expressionless: -:unamused: -:sweat_smile: -:sweat: -:disappointed_relieved: -:weary: -:pensive: -:disappointed: -:confounded: -:fearful: -:cold_sweat: -:persevere: -:cry: -:sob: -:joy: -:astonished: -:scream: -:neckbeard: -:tired_face: -:angry: -:rage: -:triumph: -:sleepy: -:yum: -:mask: -:sunglasses: -:dizzy_face: -:imp: -:smiling_imp: -:neutral_face: -:no_mouth: -:innocent: -:alien: -:yellow_heart: -:blue_heart: -:purple_heart: -:heart: -:green_heart: -:broken_heart: -:heartbeat: -:heartpulse: -:two_hearts: -:revolving_hearts: -:cupid: -:sparkling_heart: -:sparkles: -:star: -:star2: -:dizzy: -:boom: -:collision: -:anger: -:exclamation: -:question: -:grey_exclamation: -:grey_question: -:zzz: -:dash: -:sweat_drops: -:notes: -:musical_note: -:fire: -:hankey: -:poop: -:shit: -:thumbsup: -:thumbsdown: -:ok_hand: -:punch: -:facepunch: -:fist: -:v: -:wave: -:hand: -:raised_hand: -:open_hands: -:point_up: -:point_down: -:point_left: -:point_right: -:raised_hands: -:pray: -:point_up_2: -:clap: -:muscle: -:metal: -:fu: -:runner: -:running: -:couple: -:family: -:two_men_holding_hands: -:two_women_holding_hands: -:dancer: -:dancers: -:ok_woman: -:no_good: -:information_desk_person: -:raising_hand: -:bride_with_veil: -:person_with_pouting_face: -:person_frowning: -:bow: -:couplekiss: -:couple_with_heart: -:massage: -:haircut: -:nail_care: -:boy: -:girl: -:woman: -:man: -:baby: -:older_woman: -:older_man: -:person_with_blond_hair: -:man_with_gua_pi_mao: -:man_with_turban: -:construction_worker: -:cop: -:angel: -:princess: -:smiley_cat: -:smile_cat: -:heart_eyes_cat: -:kissing_cat: -:smirk_cat: -:scream_cat: -:crying_cat_face: -:joy_cat: -:pouting_cat: -:japanese_ogre: -:japanese_goblin: -:see_no_evil: -:hear_no_evil: -:speak_no_evil: -:guardsman: -:skull: -:feet: -:lips: -:kiss: -:droplet: -:ear: -:eyes: -:nose: -:tongue: -:love_letter: -:bust_in_silhouette: -:busts_in_silhouette: -:speech_balloon: -:thought_balloon: -:feelsgood: -:finnadie: -:goberserk: -:godmode: -:hurtrealbad: -:rage1: -:rage2: -:rage3: -:rage4: -:suspect: -:trollface: - -**Nature** - -:sunny: -:umbrella: -:cloud: -:snowflake: -:snowman: -:zap: -:cyclone: -:foggy: -:ocean: -:cat: -:dog: -:mouse: -:hamster: -:rabbit: -:wolf: -:frog: -:tiger: -:koala: -:bear: -:pig: -:pig_nose: -:cow: -:boar: -:monkey_face: -:monkey: -:horse: -:racehorse: -:camel: -:sheep: -:elephant: -:panda_face: -:snake: -:bird: -:baby_chick: -:hatched_chick: -:hatching_chick: -:chicken: -:penguin: -:turtle: -:bug: -:honeybee: -:ant: -:beetle: -:snail: -:octopus: -:tropical_fish: -:fish: -:whale: -:whale2: -:dolphin: -:cow2: -:ram: -:rat: -:water_buffalo: -:tiger2: -:rabbit2: -:dragon: -:goat: -:rooster: -:dog2: -:pig2: -:mouse2: -:ox: -:dragon_face: -:blowfish: -:crocodile: -:dromedary_camel: -:leopard: -:cat2: -:poodle: -:paw_prints: -:bouquet: -:cherry_blossom: -:tulip: -:four_leaf_clover: -:rose: -:sunflower: -:hibiscus: -:maple_leaf: -:leaves: -:fallen_leaf: -:herb: -:mushroom: -:cactus: -:palm_tree: -:evergreen_tree: -:deciduous_tree: -:chestnut: -:seedling: -:blossom: -:ear_of_rice: -:shell: -:globe_with_meridians: -:sun_with_face: -:full_moon_with_face: -:new_moon_with_face: -:new_moon: -:waxing_crescent_moon: -:first_quarter_moon: -:waxing_gibbous_moon: -:full_moon: -:waning_gibbous_moon: -:last_quarter_moon: -:waning_crescent_moon: -:last_quarter_moon_with_face: -:first_quarter_moon_with_face: -:crescent_moon: -:earth_africa: -:earth_americas: -:earth_asia: -:volcano: -:milky_way: -:partly_sunny: -:octocat: -:squirrel: - -**Objects** - -:bamboo: -:gift_heart: -:dolls: -:school_satchel: -:mortar_board: -:flags: -:fireworks: -:sparkler: -:wind_chime: -:rice_scene: -:jack_o_lantern: -:ghost: -:santa: -:christmas_tree: -:gift: -:bell: -:no_bell: -:tanabata_tree: -:tada: -:confetti_ball: -:balloon: -:crystal_ball: -:cd: -:dvd: -:floppy_disk: -:camera: -:video_camera: -:movie_camera: -:computer: -:tv: -:iphone: -:phone: -:telephone: -:telephone_receiver: -:pager: -:fax: -:minidisc: -:vhs: -:sound: -:speaker: -:mute: -:loudspeaker: -:mega: -:hourglass: -:hourglass_flowing_sand: -:alarm_clock: -:watch: -:radio: -:satellite: -:loop: -:mag: -:mag_right: -:unlock: -:lock: -:lock_with_ink_pen: -:closed_lock_with_key: -:key: -:bulb: -:flashlight: -:high_brightness: -:low_brightness: -:electric_plug: -:battery: -:calling: -:email: -:mailbox: -:postbox: -:bath: -:bathtub: -:shower: -:toilet: -:wrench: -:nut_and_bolt: -:hammer: -:seat: -:moneybag: -:yen: -:dollar: -:pound: -:euro: -:credit_card: -:money_with_wings: -:inbox_tray: -:outbox_tray: -:envelope: -:incoming_envelope: -:postal_horn: -:mailbox_closed: -:mailbox_with_mail: -:mailbox_with_no_mail: -:package: -:door: -:smoking: -:bomb: -:gun: -:hocho: -:pill: -:syringe: -:page_facing_up: -:page_with_curl: -:bookmark_tabs: -:bar_chart: -:chart_with_upwards_trend: -:chart_with_downwards_trend: -:scroll: -:clipboard: -:calendar: -:date: -:card_index: -:file_folder: -:open_file_folder: -:scissors: -:pushpin: -:paperclip: -:black_nib: -:pencil2: -:straight_ruler: -:triangular_ruler: -:closed_book: -:green_book: -:blue_book: -:orange_book: -:notebook: -:notebook_with_decorative_cover: -:ledger: -:books: -:bookmark: -:name_badge: -:microscope: -:telescope: -:newspaper: -:football: -:basketball: -:soccer: -:baseball: -:tennis: -:8ball: -:rugby_football: -:bowling: -:golf: -:mountain_bicyclist: -:bicyclist: -:horse_racing: -:snowboarder: -:swimmer: -:surfer: -:ski: -:spades: -:hearts: -:clubs: -:diamonds: -:gem: -:ring: -:trophy: -:musical_score: -:musical_keyboard: -:violin: -:space_invader: -:video_game: -:black_joker: -:flower_playing_cards: -:game_die: -:dart: -:mahjong: -:clapper: -:memo: -:pencil: -:book: -:art: -:microphone: -:headphones: -:trumpet: -:saxophone: -:guitar: -:shoe: -:sandal: -:high_heel: -:lipstick: -:boot: -:shirt: -:tshirt: -:necktie: -:womans_clothes: -:dress: -:running_shirt_with_sash: -:jeans: -:kimono: -:bikini: -:ribbon: -:tophat: -:crown: -:womans_hat: -:mans_shoe: -:closed_umbrella: -:briefcase: -:handbag: -:pouch: -:purse: -:eyeglasses: -:fishing_pole_and_fish: -:coffee: -:tea: -:sake: -:baby_bottle: -:beer: -:beers: -:cocktail: -:tropical_drink: -:wine_glass: -:fork_and_knife: -:pizza: -:hamburger: -:fries: -:poultry_leg: -:meat_on_bone: -:spaghetti: -:curry: -:fried_shrimp: -:bento: -:sushi: -:fish_cake: -:rice_ball: -:rice_cracker: -:rice: -:ramen: -:stew: -:oden: -:dango: -:egg: -:bread: -:doughnut: -:custard: -:icecream: -:ice_cream: -:shaved_ice: -:birthday: -:cake: -:cookie: -:chocolate_bar: -:candy: -:lollipop: -:honey_pot: -:apple: -:green_apple: -:tangerine: -:lemon: -:cherries: -:grapes: -:watermelon: -:strawberry: -:peach: -:melon: -:banana: -:pear: -:pineapple: -:sweet_potato: -:eggplant: -:tomato: -:corn: - -**Places** - -:house: -:house_with_garden: -:school: -:office: -:post_office: -:hospital: -:bank: -:convenience_store: -:love_hotel: -:hotel: -:wedding: -:church: -:department_store: -:european_post_office: -:city_sunrise: -:city_sunset: -:japanese_castle: -:european_castle: -:tent: -:factory: -:tokyo_tower: -:japan: -:mount_fuji: -:sunrise_over_mountains: -:sunrise: -:stars: -:statue_of_liberty: -:bridge_at_night: -:carousel_horse: -:rainbow: -:ferris_wheel: -:fountain: -:roller_coaster: -:ship: -:speedboat: -:boat: -:sailboat: -:rowboat: -:anchor: -:rocket: -:airplane: -:helicopter: -:steam_locomotive: -:tram: -:mountain_railway: -:bike: -:aerial_tramway: -:suspension_railway: -:mountain_cableway: -:tractor: -:blue_car: -:oncoming_automobile: -:car: -:red_car: -:taxi: -:oncoming_taxi: -:articulated_lorry: -:bus: -:oncoming_bus: -:rotating_light: -:police_car: -:oncoming_police_car: -:fire_engine: -:ambulance: -:minibus: -:truck: -:train: -:station: -:train2: -:bullettrain_front: -:bullettrain_side: -:light_rail: -:monorail: -:railway_car: -:trolleybus: -:ticket: -:fuelpump: -:vertical_traffic_light: -:traffic_light: -:warning: -:construction: -:beginner: -:atm: -:slot_machine: -:busstop: -:barber: -:hotsprings: -:checkered_flag: -:crossed_flags: -:izakaya_lantern: -:moyai: -:circus_tent: -:performing_arts: -:round_pushpin: -:triangular_flag_on_post: -:jp: -:kr: -:cn: -:us: -:fr: -:es: -:it: -:ru: -:gb: -:uk: -:de: - -**Symbols** - -:one: -:two: -:three: -:four: -:five: -:six: -:seven: -:eight: -:nine: -:keycap_ten: -:1234: -:zero: -:hash: -:symbols: -:arrow_backward: -:arrow_down: -:arrow_forward: -:arrow_left: -:capital_abcd: -:abcd: -:abc: -:arrow_lower_left: -:arrow_lower_right: -:arrow_right: -:arrow_up: -:arrow_upper_left: -:arrow_upper_right: -:arrow_double_down: -:arrow_double_up: -:arrow_down_small: -:arrow_heading_down: -:arrow_heading_up: -:leftwards_arrow_with_hook: -:arrow_right_hook: -:left_right_arrow: -:arrow_up_down: -:arrow_up_small: -:arrows_clockwise: -:arrows_counterclockwise: -:rewind: -:fast_forward: -:information_source: -:ok: -:twisted_rightwards_arrows: -:repeat: -:repeat_one: -:new: -:top: -:up: -:cool: -:free: -:ng: -:cinema: -:koko: -:signal_strength: -:u5272: -:u5408: -:u55b6: -:u6307: -:u6708: -:u6709: -:u6e80: -:u7121: -:u7533: -:u7a7a: -:u7981: -:sa: -:restroom: -:mens: -:womens: -:baby_symbol: -:no_smoking: -:parking: -:wheelchair: -:metro: -:baggage_claim: -:accept: -:wc: -:potable_water: -:put_litter_in_its_place: -:secret: -:congratulations: -:m: -:passport_control: -:left_luggage: -:customs: -:ideograph_advantage: -:cl: -:sos: -:id: -:no_entry_sign: -:underage: -:no_mobile_phones: -:do_not_litter: -:no_bicycles: -:no_pedestrians: -:children_crossing: -:no_entry: -:eight_spoked_asterisk: -:sparkle: -:eight_pointed_black_star: -:heart_decoration: -:vs: -:vibration_mode: -:mobile_phone_off: -:chart: -:currency_exchange: -:aries: -:taurus: -:gemini: -:cancer: -:leo: -:virgo: -:libra: -:scorpius: -:sagittarius: -:capricorn: -:aquarius: -:pisces: -:ophiuchus: -:six_pointed_star: -:negative_squared_cross_mark: -:a: -:b: -:ab: -:o2: -:diamond_shape_with_a_dot_inside: -:recycle: -:end: -:back: -:on: -:soon: -:clock1: -:clock130: -:clock10: -:clock1030: -:clock11: -:clock1130: -:clock12: -:clock1230: -:clock2: -:clock230: -:clock3: -:clock330: -:clock4: -:clock430: -:clock5: -:clock530: -:clock6: -:clock630: -:clock7: -:clock730: -:clock8: -:clock830: -:clock9: -:clock930: -:heavy_dollar_sign: -:copyright: -:registered: -:tm: -:x: -:heavy_exclamation_mark: -:bangbang: -:interrobang: -:o: -:heavy_multiplication_x: -:heavy_plus_sign: -:heavy_minus_sign: -:heavy_division_sign: -:white_flower: -:100: -:heavy_check_mark: -:ballot_box_with_check: -:radio_button: -:link: -:curly_loop: -:wavy_dash: -:part_alternation_mark: -:trident: -:black_small_square: -:white_small_square: -:black_medium_small_square: -:white_medium_small_square: -:black_medium_square: -:white_medium_square: -:black_large_square: -:white_large_square: -:white_check_mark: -:black_square_button: -:white_square_button: -:black_circle: -:white_circle: -:red_circle: -:large_blue_circle: -:large_blue_diamond: -:large_orange_diamond: -:small_blue_diamond: -:small_orange_diamond: -:small_red_triangle: -:small_red_triangle_down: -:shipit: - -## Keyboard - -↑ Arrow Up - -↓ Arrow Down - -← Arrow Left - -→ Arrow Right - -⇪ Caps Lock - -⌘ Command - -⌃ Control - -⌫ Delete - -⌦ Delete (Forward) - -↘ End - -⌤ Enter - -⎋ Escape - -↖ Home - -⇞ Page Up - -⇟ Page Down - -⌥ Option, Alt - -↵ Return - -⇧ Shift - -␣ Space - -⇥ Tab - -⇤ Tab + Shift - -## Misc - -**Horizontal Rule** - ---- diff --git a/docs/test/navbar.md b/docs/test/navbar.md deleted file mode 100644 index 119c58ad..00000000 --- a/docs/test/navbar.md +++ /dev/null @@ -1,46 +0,0 @@ -- Text -- [Link](http://google.com) -- [Menu (Link)](http://google.com) - - [![alt text](https://icongram.jgog.in/simple/facebook.svg?colored&size=16)Facebook](http://facebook.com) - - [![alt](https://icongram.jgog.in/simple/github.svg?colored&size=16)Github](http://github.com) - - [![alt](https://icongram.jgog.in/simple/instagram.svg?colored&size=16)Instagram](http://instagram.com) - - [![alt](https://icongram.jgog.in/simple/linkedin.svg?colored&size=16)Linkedin](http://linkedin.com) - - [![alt](https://icongram.jgog.in/simple/pinterest.svg?colored&size=16)Pinterest](http://pinterest.com) - - [![alt](https://icongram.jgog.in/simple/tumblr.svg?colored&size=16)Tumblr](http://tumblr.com) - - [![alt](https://icongram.jgog.in/simple/twitter.svg?colored&size=16)Twitter](http://twitter.com) - - [![alt](https://icongram.jgog.in/simple/youtube.svg?colored&size=16)YouTube](http://youtube.com) -- Menu (Text) - - [Alfa](#) - - [Bravo](#) - - [Charlie](#) - - [Delta](#) - - [Echo](#) - - [Foxtrot](#) - - [Golf](#) - - [Hotel](#) - - [India](#) - - [Juliett](#) - - [Kilo](#) - - [Lima](#) - - [Mike](#) - - [November](#) - - [Oscar](#) - - [Papa](#) - - [Quebec](#) - - [Romeo](#) - - [Sierra](#) - - [Tango](#) - - [Uniform](#) - - [Victor](#) - - [Whiskey](#) - - [X-ray](#) - - [Yankee](#) - - [Zulu](#) -- Themes - - Defaults - - Simple - - Simple Dark - - Vue - - Buble - - Dark - - Pure diff --git a/docs/README_cn.md b/docs/zh-cn/README.md similarity index 95% rename from docs/README_cn.md rename to docs/zh-cn/README.md index 7b1d75bc..e860e207 100644 --- a/docs/README_cn.md +++ b/docs/zh-cn/README.md @@ -1,6 +1,6 @@ # M5Stack -中文 | [English](README.md) | [日本語](docs/README_jp.md) +中文 | [English](README.md) | [日本語](docs/README_ja.md) **Welcome to M5Stack Documents!** diff --git a/docs/zh-cn/_sidebar.md b/docs/zh-cn/_sidebar.md new file mode 100644 index 00000000..5154e711 --- /dev/null +++ b/docs/zh-cn/_sidebar.md @@ -0,0 +1,11 @@ +- [介绍](/zh-cn/) +- [Product Documents](/zh-cn/product_documents.md) +- [Quick Start](/zh-cn/qurck_start.md) +- [API Rreference](/zh-cn/api_reference.md) +- [M5Stack Cases](/zh-cn/m5stack_cases.md) +- [FAQ](/zh-cn/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/faq_cn.md b/docs/zh-cn/faq.md similarity index 100% rename from docs/faq_cn.md rename to docs/zh-cn/faq.md diff --git a/docs/index_cn.md b/docs/zh-cn/index.md similarity index 100% rename from docs/index_cn.md rename to docs/zh-cn/index.md diff --git a/docs/practice_cn.md b/docs/zh-cn/practice.md similarity index 100% rename from docs/practice_cn.md rename to docs/zh-cn/practice.md diff --git a/docs/product_documents_cn.md b/docs/zh-cn/product_documents.md similarity index 100% rename from docs/product_documents_cn.md rename to docs/zh-cn/product_documents.md diff --git a/docs/quick_start_cn.md b/docs/zh-cn/quick_start.md similarity index 100% rename from docs/quick_start_cn.md rename to docs/zh-cn/quick_start.md