update m5stack navigation structure

makerfactoryio · Apr 7, 2019 · fd35383 · fd35383
1 parent cd3b88c
commit fd35383
Show file tree

Hide file tree

Showing 5 changed files with 174 additions and 163 deletions.
diff --git a/docs/assets/css/dropdown.css b/docs/assets/css/dropdown.css
@@ -50,7 +50,7 @@
 
 .dropdown:hover ul {
   overflow-y: auto;
-  height: 52rem;
+  height: 32rem;
 }
 
 .dropdown ul li {
@@ -90,6 +90,6 @@
   }
 
   .dropdown:hover ul {
-    height: 40rem;
+    height: 24rem;
   }
 }
diff --git a/docs/assets/css/layout.css b/docs/assets/css/layout.css
@@ -1,3 +1,8 @@
 .slight-padding {
   padding: 10px;
 }
+
+.bottom-aligned {
+  display: inline-block;
+  vertical-align: bottom;
+}
diff --git a/docs/index.md b/docs/index.md
@@ -1,105 +1,33 @@
 # Welcome to the Makerfactory Documentation
 
-## Development Boards
+## Development
 
-<div markdown="span" class="float-container text-center">
-  <div markdown="span" class="pull-left" style="width: 33%">
-    [![ESP32_ICON](../../images/icons/ICON_ESP32.png)](/development-boards/esp32)
+<div markdown="span" class="float-container">
+  <div markdown="span" class="slight-padding text-center bottom-aligned" style="width: 33%">
+    [![ESP32_ICON](../../images/esp32/board_ebb-esp32.jpg)](/development-boards/esp32)
     <br>
     [ESP32 Development Kit](/development-boards/esp32)
   </div>
   <!--
-  <div markdown="span" class="pull-left" style="width: 33%">
+  <div markdown="span" class="slight-padding text-center bottom-aligned" style="width: 33%">
     [![SensorIO_ICON](../../images/icons/ICON_sensorio.png)](development-boards/sensorio)
     <br>
     [SensorIO Development Kit](development-boards/sensorio)
   </div>
   -->
+  <div markdown="span" class="slight-padding text-center bottom-aligned" style="width: 33%">
+    [![M5Core BASIC](../../images/m5stack/product_pics/core/basic/basic_02.jpg)](/m5stack/overview)
+    <br>
+    [M5Stack](/m5stack/overview)
+  </div>
 </div>
 
 ## Educational Robotics
 
 <div markdown="span" class="float-container text-center">
   <div markdown="span" class="pull-left" style="width: 33%">
-    [![RoboBug_ICON](../../images/icons/ICON_robobug.png)](/educational-robotics/robobug-hexapod/quick-start/)
+    [![RoboBug_ICON](../../images/robobug-hexapod/Abb_1.png)](/educational-robotics/robobug-hexapod/quick-start/)
     <br>
     [RoboBug Hexapod](/educational-robotics/robobug-hexapod/quick-start/)
   </div>
 </div>
-
-## M5Stack
-
-### M5STACK Core
-
-<div markdown="span" class="float-container text-center">
-  <div markdown="span" class="pull-left slight-padding" style="width: 33%">
-    [![M5Core BASIC](../../images/m5stack/product_pics/core/basic/basic_01.jpg)](/m5stack/core/black)
-    <br>
-    [M5Core BASIC](/m5stack/core/black)
-  </div>
-  <div markdown="span" class="pull-left slight-padding" style="width: 33%">
-    [![M5Core GRAY](../../images/m5stack/product_pics/core/gray/gray_01.jpg)](/m5stack/core/gray)
-    <br>
-    [M5Core GRAY](/m5stack/core/gray)
-  </div>
-  <div markdown="span" class="pull-left slight-padding" style="width: 33%">
-    [![M5Core FIRE](../../images/m5stack/product_pics/core/fire/product_pic_fire.jpg)](/m5stack/core/fire)
-    <br>
-    [M5Core FIRE](/m5stack/core/fire)
-  </div>
-</div>
-
-### M5STACK Kit
-
-<div markdown="span" class="float-container text-center">
-  <div markdown="span" class="pull-left slight-padding" style="width: 33%">
-    [![M5GO Kit](../../images/m5stack/product_pics/core/m5go/m5go_01.jpg)](/m5stack/kit/m5go)
-    <br>
-    [M5GO Kit](/m5stack/kit/m5go)
-  </div>
-  <div markdown="span" class="pull-left slight-padding" style="width: 33%">
-    [![FACES Kit](https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/core/kit_faces_01.png)](/m5stack/kit/faces)
-    <br>
-    [FACES Kit](/m5stack/kit/faces)
-  </div>
-</div>
-
-### M5STACK Module
-
-<div markdown="span" class="float-container text-center">
-  <div markdown="span" class="pull-left slight-padding" style="width: 33%">
-    [![GPS](../../images/m5stack/product_pics/module/module_gps_01.jpg)](/m5stack/module/gps)
-    <br>
-    [GPS](/m5stack/module/gps)
-  </div>
-  <div markdown="span" class="pull-left slight-padding" style="width: 33%">
-    [![BATTERY](../../images/m5stack/product_pics/module/module_battery_01.jpg)](/m5stack/module/battery)
-    <br>
-    [BATTERY](/m5stack/module/battery)
-  </div>
-  <div markdown="span" class="pull-left slight-padding" style="width: 33%">
-    [![PROTO](../../images/m5stack/product_pics/module/module_proto_01.jpg)](/m5stack/module/proto)
-    <br>
-    [PROTO](/m5stack/module/proto)
-  </div>
-</div>
-
-### M5STACK Unit
-
-<div markdown="span" class="float-container text-center">
-  <div markdown="span" class="pull-left slight-padding" style="width: 33%">
-    [![M5Camera](../../images/m5stack/product_pics/unit/unit_m5camera_01.jpg)](/m5stack/unit/m5camera)
-    <br>
-    [M5Camera](/m5stack/unit/m5camera)
-  </div>
-</div>
-
-### M5STACK Base
-
-<div markdown="span" class="float-container text-center">
-  <div markdown="span" class="pull-left slight-padding" style="width: 33%">
-    [![BTC](../../images/m5stack/product_pics/base/btc_01.jpg)](/m5stack/base/btc)
-    <br>
-    [BTC](/m5stack/base/btc)
-  </div>
-</div>
diff --git a/docs/m5stack/overview.md b/docs/m5stack/overview.md
@@ -0,0 +1,77 @@
+
+# M5Stack Products
+
+### M5STACK Core
+
+<div markdown="span" class="float-container text-center">
+  <div markdown="span" class="pull-left slight-padding" style="width: 33%">
+    [![M5Core BASIC](../../images/m5stack/product_pics/core/basic/basic_01.jpg)](/m5stack/core/black)
+    <br>
+    [M5Core BASIC](/m5stack/core/black)
+  </div>
+  <div markdown="span" class="pull-left slight-padding" style="width: 33%">
+    [![M5Core GRAY](../../images/m5stack/product_pics/core/gray/gray_01.jpg)](/m5stack/core/gray)
+    <br>
+    [M5Core GRAY](/m5stack/core/gray)
+  </div>
+  <div markdown="span" class="pull-left slight-padding" style="width: 33%">
+    [![M5Core FIRE](../../images/m5stack/product_pics/core/fire/product_pic_fire.jpg)](/m5stack/core/fire)
+    <br>
+    [M5Core FIRE](/m5stack/core/fire)
+  </div>
+</div>
+
+### M5STACK Kit
+
+<div markdown="span" class="float-container text-center">
+  <div markdown="span" class="pull-left slight-padding" style="width: 33%">
+    [![M5GO Kit](../../images/m5stack/product_pics/core/m5go/m5go_01.jpg)](/m5stack/kit/m5go)
+    <br>
+    [M5GO Kit](/m5stack/kit/m5go)
+  </div>
+  <div markdown="span" class="pull-left slight-padding" style="width: 33%">
+    [![FACES Kit](https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/core/kit_faces_01.png)](/m5stack/kit/faces)
+    <br>
+    [FACES Kit](/m5stack/kit/faces)
+  </div>
+</div>
+
+### M5STACK Module
+
+<div markdown="span" class="float-container text-center">
+  <div markdown="span" class="pull-left slight-padding" style="width: 33%">
+    [![GPS](../../images/m5stack/product_pics/module/module_gps_01.jpg)](/m5stack/module/gps)
+    <br>
+    [GPS](/m5stack/module/gps)
+  </div>
+  <div markdown="span" class="pull-left slight-padding" style="width: 33%">
+    [![BATTERY](../../images/m5stack/product_pics/module/module_battery_01.jpg)](/m5stack/module/battery)
+    <br>
+    [BATTERY](/m5stack/module/battery)
+  </div>
+  <div markdown="span" class="pull-left slight-padding" style="width: 33%">
+    [![PROTO](../../images/m5stack/product_pics/module/module_proto_01.jpg)](/m5stack/module/proto)
+    <br>
+    [PROTO](/m5stack/module/proto)
+  </div>
+</div>
+
+### M5STACK Unit
+
+<div markdown="span" class="float-container text-center">
+  <div markdown="span" class="pull-left slight-padding" style="width: 33%">
+    [![M5Camera](../../images/m5stack/product_pics/unit/unit_m5camera_01.jpg)](/m5stack/unit/m5camera)
+    <br>
+    [M5Camera](/m5stack/unit/m5camera)
+  </div>
+</div>
+
+### M5STACK Base
+
+<div markdown="span" class="float-container text-center">
+  <div markdown="span" class="pull-left slight-padding" style="width: 33%">
+    [![BTC](../../images/m5stack/product_pics/base/btc_01.jpg)](/m5stack/base/btc)
+    <br>
+    [BTC](/m5stack/base/btc)
+  </div>
+</div>
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -35,7 +35,7 @@ extra_javascript:
 
 nav:
 - Overview: index.md
-- Development Boards:
+- Development:
   - ESP32:
     - Quick start: development-boards/esp32/index.md
     - Getting Started:
@@ -63,33 +63,84 @@ nav:
       - TFT: development-boards/esp32/tft.md
       - Unit-Bus: development-boards/esp32/unit-bus.md
       - USB Programming: development-boards/esp32/usb-programming.md
-  - SensorIO:
-    - Introduction: 'development-boards/sensorio/index.md'
-    - Getting Started:
-      - Tooling setup: 'development-boards/sensorio/tools.md'
-      - Code setup: 'development-boards/sensorio/code-setup.md'
-      - Compilation: 'development-boards/sensorio/compilation.md'
-      - Flashing: 'development-boards/sensorio/flashing.md'
-      - Debugging: 'development-boards/sensorio/debugging.md'
-      - Demo App: 'development-boards/sensorio/demo-app.md'
-    - Hardware:
-      - Overview: 'development-boards/sensorio/hardware-overview.md'
-      - Circuit Schematics: 'development-boards/sensorio/schematics.md'
-      - Pinout diagrams: 'development-boards/sensorio/pinouts.md'
-      - Onboard sensors: 'development-boards/sensorio/sensors.md'
-      - Expansion Interfaces: 'development-boards/sensorio/interfaces.md'
-      - Technical specifications: 'development-boards/sensorio/datasheet.md'
-    - Firmware:
-      - Overview: 'development-boards/sensorio/fw-overview.md'
-      - Sensors:
-        - Light sensor: 'development-boards/sensorio/ltr303.md'
-        - Accelerometer: 'development-boards/sensorio/bma253.md'
-      - Peripherals:
-        - Display: 'development-boards/sensorio/oled.md'
-        - Relays: 'development-boards/sensorio/relays.md'
-        - RGB Led: 'development-boards/sensorio/rgbled.md'
-        - User button: 'development-boards/sensorio/button.md'
-        - Multiplexers: 'development-boards/sensorio/multiplexers.md'
+  - M5STACK:
+    - Products:
+      - Overview: 'm5stack/overview.md'
+      - M5STACK Core:
+        - M5Core BASIC: 'm5stack/core/black.md'
+        - M5Core GRAY: 'm5stack/core/gray.md'
+        - M5Core FIRE: 'm5stack/core/fire.md'
+        - Quickstart:
+          - Overview: 'm5stack/core/quickstart/overview.md'
+          - Windows: 'm5stack/core/quickstart/windows.md'
+          - macOS: 'm5stack/core/quickstart/macos.md'
+          - UIFlow: 'm5stack/core/quickstart/uiflow.md'
+          - M5Cloud: 'm5stack/core/quickstart/m5cloud.md'
+      - M5STACK Kit:
+        - M5GO Kit: 'm5stack/kit/m5go.md'
+        - FACES Kit: 'm5stack/kit/faces.md'
+        - PROTO Kit: 'm5stack/kit/proto.md'
+        - WRISTBAND Kit: 'm5stack/kit/wristband.md'
+        - Quickstart:
+          - FACES NES Game: 'm5stack/kit/quickstart/faces-nes.md'
+      - M5STACK Module:
+        - GPS: 'm5stack/module/gps.md'
+        - BATTERY: 'm5stack/module/battery.md'
+        - PROTO: 'm5stack/module/proto.md'
+      - M5STACK Unit:
+        - M5Camera: 'm5stack/unit/m5camera.md'
+        - Quickstart: 'm5stack/unit/quickstart.md'
+      - M5STACK Base:
+        - FACES Base: 'm5stack/base/faces.md'
+        - Frame Base: 'm5stack/base/frame.md'
+        - Loading Base: 'm5stack/base/btc.md'
+        - M5GO Base: 'm5stack/base/m5go.md'
+        - M5GO Charger: 'm5stack/base/m5go_charger.md'
+    - Arduino API:
+      - Overview: 'm5stack/api/overview.md'
+      - Button: 'm5stack/api/button.md'
+      - LCD: 'm5stack/api/lcd.md'
+      - MPU9250: 'm5stack/api/mpu9250.md'
+      - Power: 'm5stack/api/power.md'
+      - Speaker: 'm5stack/api/speaker.md'
+      - System: 'm5stack/api/system.md'
+      - TF: 'm5stack/api/tf.md'
+    - Use-Cases: 'm5stack/cases.md'
+    - Related Documents:
+      - Overview: 'm5stack/related-documents/overview.md'
+      - Establish Serial Connection: 'm5stack/related-documents/serial-connection.md'
+      - How to Install Git and Arduino: 'm5stack/related-documents/git-arduino.md'
+      - Upgrade M5Stack Lib: 'm5stack/related-documents/upgrade-lib.md'
+      - How to Burn Firmware: 'm5stack/related-documents/burn-firmware.md'
+      - How to Connect WiFi Using Core: 'm5stack/related-documents/wifi-core.md'
+      - How to Connect WiFi Using M5Cloud: 'm5stack/related-documents/wifi-m5cloud.md'
+  # - SensorIO:
+  #   - Introduction: 'development-boards/sensorio/index.md'
+  #   - Getting Started:
+  #     - Tooling setup: 'development-boards/sensorio/tools.md'
+  #     - Code setup: 'development-boards/sensorio/code-setup.md'
+  #     - Compilation: 'development-boards/sensorio/compilation.md'
+  #     - Flashing: 'development-boards/sensorio/flashing.md'
+  #     - Debugging: 'development-boards/sensorio/debugging.md'
+  #     - Demo App: 'development-boards/sensorio/demo-app.md'
+  #   - Hardware:
+  #     - Overview: 'development-boards/sensorio/hardware-overview.md'
+  #     - Circuit Schematics: 'development-boards/sensorio/schematics.md'
+  #     - Pinout diagrams: 'development-boards/sensorio/pinouts.md'
+  #     - Onboard sensors: 'development-boards/sensorio/sensors.md'
+  #     - Expansion Interfaces: 'development-boards/sensorio/interfaces.md'
+  #     - Technical specifications: 'development-boards/sensorio/datasheet.md'
+  #   - Firmware:
+  #     - Overview: 'development-boards/sensorio/fw-overview.md'
+  #     - Sensors:
+  #       - Light sensor: 'development-boards/sensorio/ltr303.md'
+  #       - Accelerometer: 'development-boards/sensorio/bma253.md'
+  #     - Peripherals:
+  #       - Display: 'development-boards/sensorio/oled.md'
+  #       - Relays: 'development-boards/sensorio/relays.md'
+  #       - RGB Led: 'development-boards/sensorio/rgbled.md'
+  #       - User button: 'development-boards/sensorio/button.md'
+  #       - Multiplexers: 'development-boards/sensorio/multiplexers.md'
 
 - Educational Robotics:
   - Hexapod Robobug Platform:
@@ -124,56 +175,6 @@ nav:
       - Avoid obstacles with an ultrasonic sensor: 'educational-robotics/robobug-hexapod/project_us_demo.md'
       - Follow objects with an ultrasonic sensor: 'educational-robotics/robobug-hexapod/project_us_follow.md'
 
-- M5STACK:
-  - Products:
-    - M5STACK Core:
-      - M5Core BASIC: 'm5stack/core/black.md'
-      - M5Core GRAY: 'm5stack/core/gray.md'
-      - M5Core FIRE: 'm5stack/core/fire.md'
-      - Quickstart:
-        - Overview: 'm5stack/core/quickstart/overview.md'
-        - Windows: 'm5stack/core/quickstart/windows.md'
-        - macOS: 'm5stack/core/quickstart/macos.md'
-        - UIFlow: 'm5stack/core/quickstart/uiflow.md'
-        - M5Cloud: 'm5stack/core/quickstart/m5cloud.md'
-    - M5STACK Kit:
-      - M5GO Kit: 'm5stack/kit/m5go.md'
-      - FACES Kit: 'm5stack/kit/faces.md'
-      - PROTO Kit: 'm5stack/kit/proto.md'
-      - WRISTBAND Kit: 'm5stack/kit/wristband.md'
-      - Quickstart:
-        - FACES NES Game: 'm5stack/kit/quickstart/faces-nes.md'
-    - M5STACK Module:
-      - GPS: 'm5stack/module/gps.md'
-      - BATTERY: 'm5stack/module/battery.md'
-      - PROTO: 'm5stack/module/proto.md'
-    - M5STACK Unit:
-      - M5Camera: 'm5stack/unit/m5camera.md'
-      - Quickstart: 'm5stack/unit/quickstart.md'
-    - M5STACK Base:
-      - FACES Base: 'm5stack/base/faces.md'
-      - Frame Base: 'm5stack/base/frame.md'
-      - Loading Base: 'm5stack/base/btc.md'
-      - M5GO Base: 'm5stack/base/m5go.md'
-      - M5GO Charger: 'm5stack/base/m5go_charger.md'
-  - Arduino API:
-    - Overview: 'm5stack/api/overview.md'
-    - Button: 'm5stack/api/button.md'
-    - LCD: 'm5stack/api/lcd.md'
-    - MPU9250: 'm5stack/api/mpu9250.md'
-    - Power: 'm5stack/api/power.md'
-    - Speaker: 'm5stack/api/speaker.md'
-    - System: 'm5stack/api/system.md'
-    - TF: 'm5stack/api/tf.md'
-  - Use-Cases: 'm5stack/cases.md'
-  - Related Documents:
-    - Overview: 'm5stack/related-documents/overview.md'
-    - Establish Serial Connection: 'm5stack/related-documents/serial-connection.md'
-    - How to Install Git and Arduino: 'm5stack/related-documents/git-arduino.md'
-    - Upgrade M5Stack Lib: 'm5stack/related-documents/upgrade-lib.md'
-    - How to Burn Firmware: 'm5stack/related-documents/burn-firmware.md'
-    - How to Connect WiFi Using Core: 'm5stack/related-documents/wifi-core.md'
-    - How to Connect WiFi Using M5Cloud: 'm5stack/related-documents/wifi-m5cloud.md'
 
 markdown_extensions:
   - markdown.extensions.admonition