initial commit, add doc framework

Author: Neutree

.bookignore

@@ -0,0 +1,17 @@
+/config/
+gulpfile.js
+.markdownlint.json
+package.json
+.gitignore
+.bookignore
+/README.md
+/zh/CONTRIBUTING.md
+*.xlsx
+*.orig
+*.less
+*.ai
+.travis.yml
+deploy.sh
+serve.sh
+serve_daemon.sh
+

.gitignore

@@ -0,0 +1,10 @@
+npm-debug.log
+.DS_Store
+node_modules/
+output/
+.vscode/
+_book/
+*.epub
+*.mobi
+serve.tmp
+*-lock.json

.markdownlint.json

@@ -0,0 +1,5 @@
+{
+    "fenced-code-language": false,
+    "ol-prefix": false,
+    "line-length": false
+}

.travis.yml

@@ -0,0 +1,48 @@
+language: node_js
+
+node_js:
+  - "8"
+
+# 缓存依赖
+cache:
+  directories:
+    - $HOME/.npm
+
+before_install:
+  - export TZ='Asia/Shanghai' # 更改时区
+
+# 依赖安装
+install:
+  - npm install gitbook-cli -g
+  # 安装 gitbook 插件
+  - gitbook install
+
+# 构建脚本
+script:
+    # 自定义输出目录 gitbook build src dest
+  - gitbook build . ./build
+
+# 分支白名单
+branches:
+  only:
+    - master # 只对 master 分支进行构建
+    - dev
+    - /v*.*/
+
+# # GitHub Pages 部署
+# deploy:
+#   provider: pages
+#   skip_cleanup: true
+#   # 在项目仪表盘的 Settings -> Environment Variables 中配置
+#   github_token: $GITHUB_TOKEN
+#   # 将 build 目录下的内容推送到默认的 gh-pages 分支上，并不会连带 build/zh 目录一起
+#   local_dir: build/zh
+#   #fqdn: $CUSTOM_DOMAIN
+#   name: $GIT_NAME
+#   email: $GIT_EMAIL
+#   on:
+#     branch: master
+
+# 不使用travis的github pages构建功能，自定义脚本
+after_success:
+  - bash ./deploy.sh

CNAME

@@ -0,0 +1 @@
+maixpy.sipeed.com

LANGS.md

@@ -0,0 +1,2 @@
+- [English](/en)
+- [中文](/zh)

README.md

@@ -0,0 +1,45 @@
+Maixduino
+==========
+
+Arduino port for Maix series board( k210 )
+
+
+
+
+
+## Build Doc
+
+
+This documentation site is powered by GitBook. You can check out the online version here.
+
+You need Node.js and npm to be able to build the site.
+
+To install gitbook:
+
+```
+npm install gitbook-cli -g
+```
+
+Get Doc source code:
+```
+sudo apt install git 
+git clone https://github.com/sipeed/Maixduino_DOC.git
+```
+
+Install gitbook plugins:
+
+```
+cd MaixPy_DOC
+gitbook install
+```
+
+Serve as a website:
+
+```
+chmod +x serve.sh
+./serve.sh
+```
+
+Then visit http://localhost:4000
+
+

assets/BiT.png

@@ -0,0 +1,9 @@
+
+.languages{
+    margin-top: 50px;
+}
+
+.languages a{
+    color: green;
+    font-size: 18px;
+}

assets/Dan_Dock.png

@@ -0,0 +1,90 @@
+{
+    "title": "Maixduino DOC",
+    "description": "Maixduino documentation",
+    "author":"sipeed",
+    "plugins": [
+        "my-toolbar",
+        "-lunr",
+        "-search",
+        "search-title",
+        "anchor-navigation-ex",
+        "anchorjs",
+        "sharing",
+        "splitter",
+        "edit-link",
+        "ga",
+        "expandable-chapters-small@git+https://github.com/sipeed/gitbook-plugin-expandable-chapters-small.git"
+    ],
+    "styles": {
+        "website": "./styles/website.css"
+    },
+    "pluginsConfig": {
+        "github": {
+            "url": "https://github.com/sipeed/Maixduino"
+        },
+        "my-toolbar": {
+            "buttons": [
+                {
+                    "label": "Github",
+                    "text":" ",
+                    "icon": "fa fa-github",
+                    "position": "left",
+                    "target": "_blank",
+                    "url": "https://github.com/sipeed/Maixduino"
+                }
+            ]
+        },
+        "search": {
+            "maxIndexSize": 1000000000
+        },
+        
+        "lunr": {
+            "maxIndexSize": 1000000000
+        },
+        "edit-link": {
+            "base": "https://github.com/sipeed/Maixduino_DOC/blob/master",
+            "label": ""
+        },
+        "sharing": {
+            "douban": false,
+            "facebook": true,
+            "google": true,
+            "hatenaBookmark": false,
+            "instapaper": false,
+            "line": false,
+            "linkedin": false,
+            "messenger": false,
+            "pocket": false,
+            "qq": false,
+            "qzone": false,
+            "stumbleupon": false,
+            "twitter": true,
+            "viber": false,
+            "vk": false,
+            "weibo": true,
+            "whatsapp": false,
+            "all": [
+                "weibo",
+                "facebook",
+                "google",
+                "twitter",
+                "vk"
+            ]
+        },
+        "anchor-navigation-ex": {
+            "associatedWithSummary": false,
+            "showLevel": true,
+            "multipleH1": false,
+            "mode": "float",
+            "pageTop": {
+                "showLevelIcon": true,
+                "level1Icon": "fa fa-angle-double-right",
+                "level2Icon": "fa fa-angle-double-right",
+                "level3Icon": "fa fa-angle-double-right"
+            }
+        },
+        "ga": {
+            "token": "UA-119047820-3"
+        }
+    }
+}

assets/Go.jpg

@@ -0,0 +1,69 @@
+#!/bin/bash
+
+set -o errexit -o nounset
+
+rev=$(git rev-parse --short HEAD)
+BRANCH=$(if [ "$TRAVIS_PULL_REQUEST" == "false" ]; then echo $TRAVIS_BRANCH; else echo $TRAVIS_PULL_REQUEST_BRANCH; fi)
+echo "TRAVIS_BRANCH=$TRAVIS_BRANCH, BRANCH=$BRANCH"
+curr_branch=$TRAVIS_BRANCH
+
+cp -f index.html build/index.html
+cp -f assets/favicon.ico build/gitbook/images/favicon.ico
+cp -f assets/icon_sipeed.png build/gitbook/images/apple-touch-icon-precomposed-152.png
+
+git clone -b gh-pages https://github.com/sipeed/Maixduino_DOC.git ./old
+rm -rf ./old/.git/
+echo "current build branch: --$curr_branch--"
+if [[ "$curr_branch" == "master" ]]; then
+    echo "master"
+    if [[ -d './old/dev' ]]; then
+        echo "copy dev"
+        cp -r ./old/dev ./build/
+    fi
+    cd ./old
+    v_folder=`find ./ -maxdepth 1 -name 'v*.*'`
+    echo "version folder:$v_folder"
+    if [[ "x$v_folder" != "x" ]]; then
+        echo "copy version folder"
+        cp -r $v_folder ../build/
+    fi
+    cd ..
+elif [[ "$curr_branch" == "dev" ]]; then
+    echo "dev"
+    rm -rf ./old/dev
+    mkdir ./old/dev
+    cp -r ./build/* ./old/dev
+    rm -rf ./build
+    mv ./old ./build
+else
+    echo "not master or dev"
+    rm -rf ./old/$curr_branch
+    mkdir ./old/$curr_branch
+    cp -r ./build/* ./old/$curr_branch
+    rm -rf ./build
+    mv ./old ./build
+fi
+
+cd build
+
+git init
+
+git config user.name $GIT_NAME
+
+git config user.email $GIT_EMAIL
+
+git remote add upstream "https://$GITHUB_TOKEN@github.com/sipeed/Maixduino_DOC.git"
+
+# comment below because we don't need history of gh-pages, and use git push --force to cover history
+# git fetch upstream
+
+# git reset upstream/gh-pages
+
+# echo "gprs.ai-thinker.com" > CNAME
+
+git add -A
+
+git commit -m "rebuild pages at ${rev}"
+
+git push upstream HEAD:gh-pages --force
+

assets/Go_Key_Down.png

@@ -0,0 +1,14 @@
+Maixduino Documentation
+======
+
+<div class="title_pic">
+    <img src="../assets/arduino.png" height="60">  <img src="../assets/icon_sipeed2.png"  height="60">
+</div>
+
+
+
+## What is Maixduino
+
+Let the Maix series of development boards (k210 chips) support the Arduino IDE and libraries, making it easy to use a large number of existing open source Arduino libraries for rapid development and prototyping
+
+

assets/M1_Dan.png

@@ -0,0 +1,31 @@
+Summary
+=====
+
+## Introduction
+
+- [Introduction](README.md)
+
+## Hardware
+
+- [K210](hardware/k210.md)
+- [Module](hardware/module.md)
+    - [Sipeed M1](hardware/m1.md)
+- [Board](hardware/board.md)
+    - [Dan Dock](hardware/dan_dock.md)
+    - [BiT](hardware/bit.md)
+    - [Go](hardware/go.md)
+- [Peripheral Modules](hardware/peripheral_modules.md)
+    - [Microphone array](hardware/mic_array.md)
+    - [Binocular camera](hardware/binocular.md)
+    - [LCD Module](hardware/lcd.md)
+
+## Prepare
+
+- [Get Hardware](get_started/get_hardware.md)
+- [Install](get_started/install.md)
+
+
+
+
+
+