From 241d8fedd8eec556a3d1ad7ca46f2ffd841e2835 Mon Sep 17 00:00:00 2001
From: LiHuashen <854410664@qq.com>
Date: Mon, 6 May 2019 14:53:25 +0800
Subject: [PATCH] add list for illiustrating docs directory tree

---
 docs/_redirects            |   4 --
 docs/coverpage.md          |  11 ---
 docs/index.html            |  22 +-----
 docs/ja/README_ja.md       |   2 +-
 docs/sw.js                 |  83 ---------------------
 docs/zh_CN/README_zh_CN.md |   2 +-
 docs/zh_CN/module/plus.md  |   4 ++
 list.txt                   | 143 +++++++++++++++++++++++++++++++++++++
 sw.js                      |  83 ---------------------
 9 files changed, 150 insertions(+), 204 deletions(-)
 delete mode 100644 docs/_redirects
 delete mode 100644 docs/coverpage.md
 delete mode 100644 docs/sw.js
 create mode 100644 list.txt
 delete mode 100644 sw.js

diff --git a/docs/_redirects b/docs/_redirects
deleted file mode 100644
index b0e170db..00000000
--- a/docs/_redirects
+++ /dev/null
@@ -1,4 +0,0 @@
-/*    /index.html   200
-
-# Redirect default Netlify subdomain to primary domain
-http://m5-docs.netlify.com/* http://docs.m5stack.com/:splat 301!
\ No newline at end of file
diff --git a/docs/coverpage.md b/docs/coverpage.md
deleted file mode 100644
index 94472cc4..00000000
--- a/docs/coverpage.md
+++ /dev/null
@@ -1,11 +0,0 @@
-<img src="assets/img/coverpage_logo.png" width="146px">
-
-> A documentation for [M5Stack](https://www.m5stack.com)
-
-- A series of modular stackable development devices integrating WIFI/BLE
-- For Industry Development/STEM Education
-- Programming with UIFlow(Blockly/MicroPython)
-
-[Official Website](http://www.m5stack.com)
-[Introdction](#main)
-[Quick Start](/en/quick_start)
diff --git a/docs/index.html b/docs/index.html
index 73faafab..e657a595 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -22,7 +22,6 @@
             // -----------------------------------------------------------------
             name       : 'M5Stack docs',
             repo       : 'https://github.com/m5stack/m5-docs',
-            // coverpage  : 'coverpage.md',
             homepage   : 'index.md',
             loadNavbar : 'navbar.md',
             loadSidebar: 'sidebar.md',
@@ -36,14 +35,13 @@
             },
             // NAVIGATION
             // -----------------------------------------------------------------
-            alias: {
+            alias: { //重定向
                 '/en/sidebar.md': '/sidebar.md',
                 '/en/.*/sidebar.md': '/sidebar.md',
                 '/zh_CN/.*/sidebar.md': '/zh_CN/sidebar.md',
                 '/ja/.*/sidebar.md': '/ja/sidebar.md',
                 '/.*/navbar.md': '/navbar.md',
                 '/en/': '/',
-                '/.*/sw.js': '/sw.js'
             },
             auto2top   : true,
             mergeNavbar: true,
@@ -51,26 +49,8 @@
             subMaxLevel: 3,
             basePath: '/',
             formatUpdated: '{MM}/{DD} {HH}:{mm}',
-            // PLUGINS
-            // -----------------------------------------------------------------
             executeScript: true,
             ga    : 'UA-131246469-2',
-            // search: 'auto', // default
-            // search: {
-            //     maxAge: 43200000,
-            //     placeholder: {
-            //         '/zh_CN/': '搜索',
-            //         '/ja/': '検索',
-            //         '/': 'Search'
-            //     },
-            //     noData: {
-            //         '/zh_CN/': '找不到结果',
-            //         '/ja/': '見つかりませんでした',
-            //         '/': 'No Results'
-            //     }
-            // },
-            // depth: 3,
-            // hideOtherSidebarContent: false // whether or not to hide other sidebar content
         };
     </script>
     <script>
diff --git a/docs/ja/README_ja.md b/docs/ja/README_ja.md
index 54e97b42..a506ecbe 100644
--- a/docs/ja/README_ja.md
+++ b/docs/ja/README_ja.md
@@ -1,4 +1,4 @@
-# M5Stack 公式ドキュメント {docsify-ignore-all}
+# M5Stack 公式ドキュメント
 
 [中文](https://github.com/m5stack/m5-docs/blob/master/docs/zh_CN/README_zh_CN.md) | [English](https://github.com/m5stack/m5-docs/blob/master/README.md) | 日本語
 
diff --git a/docs/sw.js b/docs/sw.js
deleted file mode 100644
index 0e865b01..00000000
--- a/docs/sw.js
+++ /dev/null
@@ -1,83 +0,0 @@
-/* ===========================================================
- * docsify sw.js
- * ===========================================================
- * Copyright 2016 @huxpro
- * Licensed under Apache 2.0
- * Register service worker.
- * ========================================================== */
-
-const RUNTIME = 'docsify'
-const HOSTNAME_WHITELIST = [
-  self.location.hostname,
-  'fonts.gstatic.com',
-  'fonts.googleapis.com',
-  'unpkg.com'
-]
-
-// The Util Function to hack URLs of intercepted requests
-const getFixedUrl = (req) => {
-  var now = Date.now()
-  var url = new URL(req.url)
-
-  // 1. fixed http URL
-  // Just keep syncing with location.protocol
-  // fetch(httpURL) belongs to active mixed content.
-  // And fetch(httpRequest) is not supported yet.
-  url.protocol = self.location.protocol
-
-  // 2. add query for caching-busting.
-  // Github Pages served with Cache-Control: max-age=600
-  // max-age on mutable content is error-prone, with SW life of bugs can even extend.
-  // Until cache mode of Fetch API landed, we have to workaround cache-busting with query string.
-  // Cache-Control-Bug: https://bugs.chromium.org/p/chromium/issues/detail?id=453190
-  if (url.hostname === self.location.hostname) {
-    url.search += (url.search ? '&' : '?') + 'cache-bust=' + now
-  }
-  return url.href
-}
-
-/**
- *  @Lifecycle Activate
- *  New one activated when old isnt being used.
- *
- *  waitUntil(): activating ====> activated
- */
-self.addEventListener('activate', event => {
-  event.waitUntil(self.clients.claim())
-})
-
-/**
- *  @Functional Fetch
- *  All network requests are being intercepted here.
- *
- *  void respondWith(Promise<Response> r)
- */
-self.addEventListener('fetch', event => {
-  // Skip some of cross-origin requests, like those for Google Analytics.
-  if (HOSTNAME_WHITELIST.indexOf(new URL(event.request.url).hostname) > -1) {
-    // Stale-while-revalidate
-    // similar to HTTP's stale-while-revalidate: https://www.mnot.net/blog/2007/12/12/stale
-    // Upgrade from Jake's to Surma's: https://gist.github.com/surma/eb441223daaedf880801ad80006389f1
-    const cached = caches.match(event.request)
-    const fixedUrl = getFixedUrl(event.request)
-    const fetched = fetch(fixedUrl, { cache: 'no-store' })
-    const fetchedCopy = fetched.then(resp => resp.clone())
-
-    // Call respondWith() with whatever we get first.
-    // If the fetch fails (e.g disconnected), wait for the cache.
-    // If there’s nothing in cache, wait for the fetch.
-    // If neither yields a response, return offline pages.
-    event.respondWith(
-      Promise.race([fetched.catch(_ => cached), cached])
-        .then(resp => resp || fetched)
-        .catch(_ => { /* eat any errors */ })
-    )
-
-    // Update the cache with the version we fetched (only for ok status)
-    event.waitUntil(
-      Promise.all([fetchedCopy, caches.open(RUNTIME)])
-        .then(([response, cache]) => response.ok && cache.put(event.request, response))
-        .catch(_ => { /* eat any errors */ })
-    )
-  }
-})
\ No newline at end of file
diff --git a/docs/zh_CN/README_zh_CN.md b/docs/zh_CN/README_zh_CN.md
index 8cf71c98..948457ac 100644
--- a/docs/zh_CN/README_zh_CN.md
+++ b/docs/zh_CN/README_zh_CN.md
@@ -1,4 +1,4 @@
-# M5Stack {docsify-ignore-all}
+# M5Stack
 
 中文 | [English](https://github.com/m5stack/m5-docs/blob/master/README.md) | [日本語](https://github.com/m5stack/m5-docs/blob/master/docs/ja/README_ja.md)
 
diff --git a/docs/zh_CN/module/plus.md b/docs/zh_CN/module/plus.md
index 3f2f99b1..e69682a1 100644
--- a/docs/zh_CN/module/plus.md
+++ b/docs/zh_CN/module/plus.md
@@ -12,6 +12,10 @@
 
 通讯协议: I2C (0x62).
 
+**注意：**
+
+PLUS 上的PORT C 和 PORT B 的丝印画反了，使用时请注意。黑色的座子是 PORT B，也即 GPIO，蓝色的座子是 PORT C，也即 UART。
+
 ## 产品特性
 
 -  500mAh 锂电池
diff --git a/list.txt b/list.txt
new file mode 100644
index 00000000..04d08605
--- /dev/null
+++ b/list.txt
@@ -0,0 +1,143 @@
+D:.
+│  .eslintrc.js
+│  .gitignore
+│  LICENSE
+│  list.txt
+│  README.md            //用于在github上显示的英文版本README.md文件，网址是https://github.com/m5stack/m5-docs
+│  rollup.config.js
+│  server.js
+└─docs
+    │  .nojekyll
+    │  CNAME            //重定向到新域名 docs.m5stack.com
+    │  index.html       //******整个docs全局的配置******
+    │  index.md         //-----呈现英文版本的首页内容-----，https://docs.m5stack.com/#/en/
+    │  navbar.md        //****右上角语言栏****
+    │  sidebar.md       //呈现英文版左侧导航栏
+    │  _redirects
+    ├─assets            //******放置Docs的全局样式配置和所有的图片******
+    │  │  logo.png
+    │  │  styles.css
+    │  ├─css
+    │  │  main.css      //******全局的CSS配置******
+    │  └─js
+    ├─en
+    │  │  api.md        //英文版本的API内容的首页
+    │  │  case.md
+    │  │  faq.md        //英文版本的FAQ
+    │  │  qs.md         //所有主控的上手指南英文版导航页，在官网www.m5stac.com才能看到，网址是 https://docs.m5stack.com/#/en/qs
+    │  │  related_documents.md
+    │  ├─accessory      //存放Accessory类产品文档的文件夹
+    │  ├─api            //存放API文档的文件夹
+    │  ├─app            //存放Application类产品文档的文件夹
+    │  ├─base           //存放Base类产品文档的文件夹
+    │  ├─core           //存放Core类产品文档的文件夹
+    │  ├─module         //存放Module类产品文档的文件夹
+    │  ├─quick_start
+    │  │  ├─bala
+    │  │  │      bala_quick_start.md                                //BALA的上手指南文档
+    │  │  ├─faces
+    │  │  │      gameboy_burn_a_nes_game.md
+    │  │  ├─m5camera
+    │  │  │      m5camera_quick_start.md                            //所有Camera板子的上手指南文档
+    │  │  ├─m5core
+    │  │  │      m5stack_core_get_started_Arduino_MacOS.md          //所有M5Stack Core在Arduino上手指南文档,MacOS系统
+    │  │  │      m5stack_core_get_started_Arduino_Windows.md        //所有M5Stack Core在Arduino上手指南文档,Windows系统
+    │  │  │      m5stack_core_get_started_MicroPython.md            //所有M5Stack Core在UIFlow上手指南文档
+    │  │  │      m5stack_core_get_started_MicroPython_m5cloud.md    //所有M5Stack Core在M5Cloud上手指南文档
+    │  │  │      m5stack_core_quick_start.md                        //所有M5Stack Core上手指南的导航页
+    │  │  ├─m5stick
+    │  │  │      m5stick_quick_start.md                             //所有M5Stick上手指南的导航页
+    │  │  │      m5stick_quick_start_with_arduino_MacOS.md          //所有M5Stick在Arduino上手指南文档,MacOS系统
+    │  │  │      m5stick_quick_start_with_arduino_Windows.md        //所有M5Stick在Arduino上手指南文档,Windows系统
+    │  │  │      m5stick_quick_start_with_uiflow.md                 //所有M5Stick在UIFlow上手指南文档
+    │  │  └─m5stickc
+    │  │          m5stickc_quick_start.md                           //所有M5StickC上手指南的导航页
+    │  │          m5stickc_quick_start_with_arduino_MacOS.md        //所有M5StickC在Arduino上手指南文档,MacOS系统
+    │  │          m5stickc_quick_start_with_arduino_Windows.md      //所有M5StickC在Arduino上手指南文档,Windows系统
+    │  │          m5stickc_quick_start_with_uiflow.md               //所有M5StickC在UIFlow上手指南文档
+    │  ├─related_documents
+    │  ├─tool           //存放Tool类产品文档的文件夹
+    │  └─unit           //存放Unit类产品文档的文件夹
+    ├─ja
+    │  │  api.md        //日语版本的API内容的首页
+    │  │  case.md
+    │  │  faq.md        //日语版本的FAQ
+    │  │  qs.md         //所有主控的上手指南日语版导航页，网址是 https://docs.m5stack.com/#/ja/qs
+    │  │  README.md     //-----呈现日语版本的首页内容-----，https://docs.m5stack.com/#/ja/
+    │  │  README_ja.md  //用于在github上显示的日语版本README.md文件，网址是https://github.com/m5stack/m5-docs/blob/master/docs/ja/README_ja.md
+    │  │  related_documents.md
+    │  │  sidebar.md    //呈现日语版左侧导航栏
+    │  ├─accessory      //存放Accessory类产品文档的文件夹
+    │  ├─api            //存放API文档的文件夹
+    │  ├─app            //存放Application类产品文档的文件夹
+    │  ├─base           //存放Base类产品文档的文件夹
+    │  ├─core           //存放Core类产品文档的文件夹
+    │  ├─module         //存放Module类产品文档的文件夹
+    │  ├─quick_start
+    │  │  ├─bala
+    │  │  │      bala_quick_start.md
+    │  │  ├─faces
+    │  │  │      gameboy_burn_a_nes_game.md
+    │  │  ├─m5camera
+    │  │  │      m5camera_quick_start.md
+    │  │  ├─m5core
+    │  │  │      m5stack_core_get_started_Arduino_MacOS.md
+    │  │  │      m5stack_core_get_started_Arduino_Windows.md
+    │  │  │      m5stack_core_get_started_MicroPython.md
+    │  │  │      m5stack_core_get_started_MicroPython_m5cloud.md
+    │  │  │      m5stack_core_quick_start.md
+    │  │  ├─m5stick
+    │  │  │      m5stick_quick_start.md
+    │  │  │      m5stick_quick_start_with_arduino.md
+    │  │  │      m5stick_quick_start_with_arduino_MacOS.md
+    │  │  │      m5stick_quick_start_with_arduino_Windows.md
+    │  │  │      m5stick_quick_start_with_uiflow.md
+    │  │  └─m5stickc
+    │  │          m5stickc_quick_start.md
+    │  │          m5stickc_quick_start_with_arduino_MacOS.md
+    │  │          m5stickc_quick_start_with_arduino_Windows.md
+    │  │          m5stickc_quick_start_with_uiflow.md
+    │  ├─related_documents
+    │  ├─tool
+    │  └─unit           //存放Unit类产品文档的文件夹
+    └─zh_CN
+        │  api.md       //中文版本的API内容的首页
+        │  case.md
+        │  faq.md       //中文版本的FAQ
+        │  qs.md        //所有主控的上手指南中文版导航页，网址是 https://docs.m5stack.com/#/ja/qs
+        │  README.md    //-----呈现中文版本的首页内容----- 网址是https://docs.m5stack.com/#/zh_CN/
+        │  README_zh_CN.md  //用于在github上显示的中文版本README.md文件，网址是https://github.com/m5stack/m5-docs/blob/master/docs/zh_CN/README_zh_CN.md
+        │  related_documents.md
+        │  sidebar.md   //呈现中文版左侧导航栏
+        ├─accessory
+        ├─api           //存放API文档的文件夹
+        ├─app           //存放Application类产品文档的文件夹
+        ├─base          //存放Base类产品文档的文件夹
+        ├─core          //存放Core类产品文档的文件夹
+        ├─module        //存放Module类产品文档的文件夹
+        ├─quick_start
+        │  ├─bala
+        │  │      bala_quick_start.md
+        │  ├─faces
+        │  │      gameboy_burn_a_nes_game.md
+        │  ├─m5camera
+        │  │      m5camera_quick_start.md
+        │  ├─m5core
+        │  │      m5stack_core_get_started_Arduino_MacOS.md
+        │  │      m5stack_core_get_started_Arduino_Windows.md
+        │  │      m5stack_core_get_started_MicroPython.md
+        │  │      m5stack_core_get_started_MicroPython_m5cloud.md
+        │  │      m5stack_core_quick_start.md
+        │  ├─m5stick
+        │  │      m5stick_quick_start.md
+        │  │      m5stick_quick_start_with_arduino_MacOS.md
+        │  │      m5stick_quick_start_with_arduino_Windows.md
+        │  │      m5stick_quick_start_with_uiflow.md
+        │  └─m5stickc
+        │          m5stickc_quick_start.md
+        │          m5stickc_quick_start_with_arduino_MacOS.md
+        │          m5stickc_quick_start_with_arduino_Windows.md
+        │          m5stickc_quick_start_with_uiflow.md
+        ├─related_documents
+        ├─tool
+        └─unit          //存放Unit类产品文档的文件夹
diff --git a/sw.js b/sw.js
deleted file mode 100644
index 0e865b01..00000000
--- a/sw.js
+++ /dev/null
@@ -1,83 +0,0 @@
-/* ===========================================================
- * docsify sw.js
- * ===========================================================
- * Copyright 2016 @huxpro
- * Licensed under Apache 2.0
- * Register service worker.
- * ========================================================== */
-
-const RUNTIME = 'docsify'
-const HOSTNAME_WHITELIST = [
-  self.location.hostname,
-  'fonts.gstatic.com',
-  'fonts.googleapis.com',
-  'unpkg.com'
-]
-
-// The Util Function to hack URLs of intercepted requests
-const getFixedUrl = (req) => {
-  var now = Date.now()
-  var url = new URL(req.url)
-
-  // 1. fixed http URL
-  // Just keep syncing with location.protocol
-  // fetch(httpURL) belongs to active mixed content.
-  // And fetch(httpRequest) is not supported yet.
-  url.protocol = self.location.protocol
-
-  // 2. add query for caching-busting.
-  // Github Pages served with Cache-Control: max-age=600
-  // max-age on mutable content is error-prone, with SW life of bugs can even extend.
-  // Until cache mode of Fetch API landed, we have to workaround cache-busting with query string.
-  // Cache-Control-Bug: https://bugs.chromium.org/p/chromium/issues/detail?id=453190
-  if (url.hostname === self.location.hostname) {
-    url.search += (url.search ? '&' : '?') + 'cache-bust=' + now
-  }
-  return url.href
-}
-
-/**
- *  @Lifecycle Activate
- *  New one activated when old isnt being used.
- *
- *  waitUntil(): activating ====> activated
- */
-self.addEventListener('activate', event => {
-  event.waitUntil(self.clients.claim())
-})
-
-/**
- *  @Functional Fetch
- *  All network requests are being intercepted here.
- *
- *  void respondWith(Promise<Response> r)
- */
-self.addEventListener('fetch', event => {
-  // Skip some of cross-origin requests, like those for Google Analytics.
-  if (HOSTNAME_WHITELIST.indexOf(new URL(event.request.url).hostname) > -1) {
-    // Stale-while-revalidate
-    // similar to HTTP's stale-while-revalidate: https://www.mnot.net/blog/2007/12/12/stale
-    // Upgrade from Jake's to Surma's: https://gist.github.com/surma/eb441223daaedf880801ad80006389f1
-    const cached = caches.match(event.request)
-    const fixedUrl = getFixedUrl(event.request)
-    const fetched = fetch(fixedUrl, { cache: 'no-store' })
-    const fetchedCopy = fetched.then(resp => resp.clone())
-
-    // Call respondWith() with whatever we get first.
-    // If the fetch fails (e.g disconnected), wait for the cache.
-    // If there’s nothing in cache, wait for the fetch.
-    // If neither yields a response, return offline pages.
-    event.respondWith(
-      Promise.race([fetched.catch(_ => cached), cached])
-        .then(resp => resp || fetched)
-        .catch(_ => { /* eat any errors */ })
-    )
-
-    // Update the cache with the version we fetched (only for ok status)
-    event.waitUntil(
-      Promise.all([fetchedCopy, caches.open(RUNTIME)])
-        .then(([response, cache]) => response.ok && cache.put(event.request, response))
-        .catch(_ => { /* eat any errors */ })
-    )
-  }
-})
\ No newline at end of file