Merge branch 'dev' into dev-merge-android

Conflicts: doc/components/list.md
tomdyqin · Jun 27, 2016 · 840b7ec · 840b7ec
2 parents fc7862c + c2c2f4a
commit 840b7ec
Show file tree

Hide file tree

Showing 370 changed files with 71,550 additions and 438 deletions.
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,9 @@
+0. It's ***RECOMMENDED*** to [submit PR](https://github.com/alibaba/weex/pulls) for typo, new demo or tiny bugfix.
+0. If this's a ***BUG***, pls provide: course repetition, error/crash log, device model, OS version, App version (playground or other apps).
+0. If this's a ***FEATURE***, pls provide: details, pseudo codes if necessary.
+
+---
+
+0. 我们***推荐***小问题直接[提 PR](https://github.com/alibaba/weex/pulls)，如错别字、新 demo 或 bugfix。
+0. 如果是 ***Bug***，请提供：复现步骤（推荐有截图）、error/crash log、设备型号、OS 版本、App 版本（playground 版本或自己的 app）。
+0. 如果是***新需求***，请提供：详细描述、应用场景、适当的伪代码（如有）。
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,9 @@
+It's ***RECOMMENDED*** to submit typo fix, new demo and tiny bugfix to `dev` branch. New feature and other modifications can be submitted to "domain" branch including `ios`, `android`, `jsfm`, `html5`.
+
+See [Branch Strategy](https://github.com/alibaba/weex/blob/dev/CONTRIBUTING.md#branch-management) for more detail.
+
+---
+
+错别字修改、新 demo、较小的 bugfix 都可以直接提到 `dev` 分支；新需求以及任何你不确定影响面的改动，请提交到对应“领域”的分支（`ios`、`android`、`jsfm`、`html5`）。
+
+查看完整的[分支策略 (英文)](https://github.com/alibaba/weex/blob/dev/CONTRIBUTING.md#branch-management)。
diff --git a/README.md b/README.md
@@ -9,16 +9,20 @@ We agree that you may discuss technical information about Weex, except that you
 
 > A framework for building Mobile cross-platform UI.
 
-Support Android 4.1 (API 16) and iOS soon. See [Weex website](http://alibaba.github.io/weex/) for more information. 
+Support Android 4.1 (API 16) and iOS 7.0+. See [Weex website](http://alibaba.github.io/weex/) for more information. 
+
+## For Windows
+
+Please ***INSTALL [Git for Windows](https://git-scm.com/download/win)*** and run all the following commands in git-bash.
 
 ## Meet Weex
 
 * [Install Playground](http://alibaba.github.io/weex/download.html).
 
 ## Use Weex
 
-* See [Tutorial](https://github.com/alibaba/weex/blob/dev/doc/tutorial.md).
-* See [Weex Documentation](https://github.com/alibaba/weex/blob/dev/doc/INSTALL.md) for more information.
+* See [Tutorial](http://alibaba.github.io/weex/doc/tutorial.html).
+* See [Weex Documentation](http://alibaba.github.io/weex/doc/) for more information.
 
 ### Android 
 
@@ -34,17 +38,30 @@ Support Android 4.1 (API 16) and iOS soon. See [Weex website](http://alibaba.git
     0. Click <img src="http://gtms04.alicdn.com/tps/i4/TB1wCcqMpXXXXakXpXX3G7tGXXX-34-44.png" height="16" > (`Run` button)
 0. [Add an example](./examples/README.md#add-an-example)
 
-## Scripts
+### iOS
 
-See [SCRIPTS.md](SCRIPTS.md) for more information.
+0. Prerequisites
+	0. Install [Node.js](http://nodejs.org/) 4.0+
+    0. Under project root 
+        0. `npm install`, install project 
+        0. `./start`
+    0. Install [iOS Environment](https://developer.apple.com/library/ios/documentation/IDEs/Conceptual/AppStoreDistributionTutorial/Setup/Setup.html)
+    0. Install [CocoaPods](https://guides.cocoapods.org/using/getting-started.html)
+ 0. Run playground
+    0. `cd ios/playground`
+    0. `pod install`
+    0. Open `WeexDemo.xcworkspace` in Xcode
+    0. Click <img src="http://img1.tbcdn.cn/L1/461/1/5470b677a2f2eaaecf412cc55eeae062dbc275f9" height="16" > (`Run` button) or use default hot key `cmd + r` in xcode
+    0. If you want to run demo on your device. In `DemoDefine.h`(you can search this file by Xcode default hot key `cmd+space+o`), modify `CURRENT_IP` to your local IP
+0. [Add an example](./examples/README.md#add-an-example)
 
-## For Windows
+## Scripts
 
-Please install [Git for Windows](https://git-scm.com/download/win).
+See [SCRIPTS.md](./SCRIPTS.md) for more information.
 
 ## FAQ
 
-See [FAQ](./doc/faq.md) for more information.
+See [FAQ](http://alibaba.github.io/weex/doc/faq.html) for more information.
 
 ## Contributing
 

diff --git a/doc/README.md b/doc/README.md
@@ -1,6 +1,7 @@
 # Weex
 
 Table of Contents
+
 * [Tutorial](./tutorial.md)
 * [Guide](./guide.md)
 * [References](./references/main.md)

diff --git a/doc/SUMMARY.md b/doc/SUMMARY.md
@@ -14,15 +14,23 @@
         * [Page Config & Data](/syntax/config-n-data.md)
     * [How-tos](/how-to/main.md)
         * [Require 3rd-party Libs](/how-to/require-3rd-party-libs.md)
-        * [Transform Code Into JS Bundle](/how-to/transform-code-into-js-bundle.md)
+        * [Preview In Browser](/how-to/preview-in-browser.md)
+        * [Preview in Native]/how-to/preview-in-playground-app.md)        
+        * [Customize a native Component](/how-to/customize-a-native-component.md)
+        * [Customize native APIs](/how-to/cuszomize-native-apis.md)
+        * [Debug in html5 renderer](/how-to/debug-with-html5.md)
+        * [Require 3rd Party Libs](/how-to/require-3rd-party-libs.md)
+        * [Transform Code Into JS Bundle](/how-to/transform-code-into-js-bundle.md)       
+
     * [Advanced](/advanced/main.md)
         * [How It Works](/advanced/how-it-works.md)
         * [How Data Binding Works](/advanced/how-data-binding-works.md)
         * [Integrate to Android](/advanced/integrate-to-android.md)
+        * [Integrate to iOS](/advanced/integrate-to-ios.md)
         * [Extend to Android](/advanced/extend-to-android.md)
-        * [Integrate to HTML5](/advanced/integrate-to-html5.md)
-        * [Extend to HTML5](/advanced/extend-to-html5.md)
+        * [Extend to iOS](/advanced/extend-to-ios.md)
 * [References](/references/main.md)
+
     * [Bootstrap](/references/bootstrap.md)
     * [Component Definition](/references/component-defs.md)
     * [Instance APIs](/references/api.md)
@@ -32,26 +40,28 @@
             * [Text Style](/references/text-style.md)
         * [Common Event](/references/common-event.md)
         * [Special Element](/components/special-element.md)
-        * [&lt;div&gt;](/components/div.md)
-        * [&lt;scroller&gt;](/components/scroller.md)
-        * [&lt;list&gt;](/components/list.md)
-            * [&lt;cell&gt;](/components/cell.md)
-        * [&lt;text&gt;](/components/text.md)
-        * [&lt;image&gt;](/components/image.md)
-        * [&lt;input&gt;](/components/input.md)
-        * [&lt;switch&gt;](/components/switch.md)
-        * [&lt;slider&gt;](/components/slider.md)
-            * [&lt;indicator&gt;](/components/indicator.md)
-        * [&lt;video&gt;](/components/video.md)
-        * [&lt;a&gt;](/components/a.md)
-        * [&lt;web&gt;](/components/web.md)
-        * [&lt;wxc-tabbar&gt;](/components/wxc-tabbar.md)
+        * [div](/components/div.md)
+        * [scroller](/components/scroller.md)
+        * [list](/components/list.md)
+            * [cell](/components/cell.md)
+        * [text](/components/text.md)
+        * [image](/components/image.md)
+        * [input](/components/input.md)
+        * [switch](/components/switch.md)
+        * [slider](/components/slider.md)
+            * [indicator](/components/indicator.md)
+        * [video](/components/video.md)
+        * [a](/components/a.md)
+        * [web](/components/web.md)
+        * [wxc-tabbar](/components/wxc-tabbar.md)
+        * [wxc-navpage](/components/wxc-navpage.md)
     * [Built-in Modules](/modules/README.md)
         * [dom](/modules/dom.md)
-        * [steam](/modules/stream.md)
+        * [stream](/modules/stream.md)
         * [modal](/modules/modal.md)
         * [animation](/modules/animation.md)
         * [webview](/modules/webview.md)
+        * [navigator](/modules/navigator.md)
     * Low-level Specs
         * [JS Bundle Format](/specs/js-bundle-format.md)
         * [JS Framework APIs](/specs/js-framework-apis.md)

diff --git a/doc/_layouts/website/languages.html b/doc/_layouts/website/languages.html
@@ -10,7 +10,7 @@ <h3>{{ "LANGS_CHOOSE"|t }}</h3>
         <ul class="languages">
         {%  for lang in languages.list %}
             <li>
-                <a href="../{{ lang.id }}/">{{ lang.title }}</a>
+                <a href="{{ (lang.id + "/README.md")|contentURL }}">{{ lang.title }}</a>
             </li>
         {% endfor %}
         </ul>

diff --git a/doc/_layouts/website/layout.html b/doc/_layouts/website/layout.html
@@ -11,15 +11,15 @@
 {% endblock %}
 
 {% block style %}
-    {# Include theme css before plugins css #}
+    {### Include theme css before plugins css ###}
     <link rel="stylesheet" href="{{ "style.css"|resolveAsset }}">
 
     {{ super() }}
 
-    {# Custom stylesheets for the book #}
+    {### Custom stylesheets for the book ###}
 
     {% for type, style in config.styles %}
-        {% if style|fileExists and type == "website" %}
+        {% if fileExists(style) and type == "website" %}
         <link rel="stylesheet" href="{{ style|resolveFile }}">
         {% endif %}
     {% endfor %}

diff --git a/doc/_layouts/website/page.html b/doc/_layouts/website/page.html
@@ -12,106 +12,94 @@
     {% if page.previous and page.previous.path %}
     <link rel="prev" href="{{ page.previous.path|resolveFile }}" />
     {% endif %}
-    <link rel="stylesheet" href="http://alibaba.github.io/weex/css/site.css">
+
+    <link rel="stylesheet"  href="//g.alicdn.com/mtb/lab-zikuan/0.1.3/weex/weex_doc.css" >
+    <!--     
+    <link rel="stylesheet"  href="ali_addition/weex_doc.css" >
+    -->
+
+    <link rel="icon" type="image/x-icon" href="http://alibaba.github.io/weex/img/favicon.ico">
+
+    <script src="//g.alicdn.com/mtb/lab-zikuan/0.1.3/weex/weex_doc.js"></script>
     <!-- 
-    <link rel="stylesheet" href="http://127.0.0.1/taobao/weex/docs/ali_addition/weex_doc.css">
+    <script src="ali_addition/weex_doc.js"></script>
     -->    
-    <link rel="stylesheet"  href="http://alibaba.github.io/weex/css/weex_doc.css" >    
-    <link rel="icon" type="image/x-icon" href="http://alibaba.github.io/weex/img/favicon.ico">    
 
+    <link rel="stylesheet"  href="http://g.alicdn.com/mtb/lab-zikuan/0.1.3/weex/weex_doc.css" >    
+    <link rel="icon" type="image/x-icon" href="http://alibaba.github.io/weex/img/favicon.ico">    
 {% endblock %}
 
 {% block javascript %}
-    <script src="{{ "app.js"|resolveAsset }}"></script>
+    <script src="{{ "gitbook.js"|resolveAsset }}"></script>
+    <script src="{{ "theme.js"|resolveAsset }}"></script>
     {% for resource in plugins.resources.js %}
         {% if resource.url %}
         <script src="{{ resource.url }}"></script>
         {% else %}
         <script src="{{ resource.path|resolveAsset }}"></script>
         {% endif %}
     {% endfor %}
-    <script>
-    require(["gitbook"], function(gitbook) {
-        gitbook.start({{ config.pluginsConfig|dump|safe }});
-    });
-    </script>
-
-
 {% endblock %}
 
 {% block body %}
-<div class="book"
-    data-level="{{ page.level }}"
-    data-chapter-title="{{ page.title }}"
-    data-filepath="{{ file.path }}"
-    data-basepath="{{ './'|resolveFile }}"
-    data-revision="{{ gitbook.time }}"
-    data-innerlanguage="{{ innerlanguage }}">
-
-    <div class="weex-doc-header">
-        <div class="top-bar">
-                <div class="top-bar-title"></div>
-                <div class="top-bar-left">
-                    <ul  class="menu" role="menubar" >
-                        <li role="menuitem">
-                            <a href='http://alibaba.github.io/weex/index.html'>Weex</a>                            
-                        </li>
-                        <li role="menuitem">
-                            Docs
-                        </li>
-                        <li role="menuitem">
-                            <a href='http://alibaba.github.io/weex/demo.html'>Demo</a>                            
-                        </li>
-                        <li role="menuitem">
-                        </li>
-                        <li role="menuitem" >
-                            <a href="http://alibaba.github.io/weex/community.html">Community</a>
-                        </li>
-                    </ul>
-                </div>
-                <div class="top-bar-right">
-                    <ul class="menu">
-                        <li><a href="https://github.com/alibaba/weex/">Github</a>
-                        </li>
-                    </ul>
-                </div>
-        </div>        
-    </div>
+<div class="book">
 
-    {% include "website/summary.html" %}
+    {% include "website/weex_header.html" %}
+
+    <div class="book-summary">
+        {% block book_sidebar %}
+            {% block search_input %}{% endblock %}
+            {% block book_summary %}
+                <nav role="navigation">
+                {% include "website/summary.html" %}
+                </nav>
+            {% endblock %}
+        {% endblock %}
+    </div>
 
     <div class="book-body">
-
         {% block book_body %}
             <div class="body-inner">
                 {% block book_inner %}
                     {% include "website/header.html" %}
 
                     <div class="page-wrapper" tabindex="-1" role="main">
                         <div class="page-inner">
-                            <section class="normal markdown-section">
-                            {% block page %}
-                            {{ page.content|safe }}
+                            {% block search_results %}
+                                <section class="normal markdown-section">
+                                {% block page %}
+                                {{ page.content|safe }}
+                                {% endblock %}
+                                </section>
                             {% endblock %}
-                            </section>
                         </div>
                     </div>
                 {% endblock %}
             </div>
 
             {% block book_navigation %}
                 {% if page.previous and page.previous.path %}
-                <a href="{{ page.previous.path|resolveFile }}" class="navigation navigation-prev {% if not (page.next and page.next.path) %}navigation-unique{% endif %}" aria-label="Previous page: {{ page.previous.title }}">
+                <a href="{{ page.previous.path|resolveFile }}{{ page.previous.anchor }}" class="navigation navigation-prev {% if not (page.next and page.next.path) %}navigation-unique{% endif %}" aria-label="Previous page: {{ page.previous.title }}">
                     <i class="fa fa-angle-left"></i>
                 </a>
                 {% endif %}
                 {% if page.next and page.next.path %}
-                <a href="{{ page.next.path|resolveFile }}" class="navigation navigation-next {% if not (page.previous and page.previous.path) %}navigation-unique{% endif %}" aria-label="Next page: {{ page.next.title }}">
+                <a href="{{ page.next.path|resolveFile }}{{ page.next.anchor }}" class="navigation navigation-next {% if not (page.previous and page.previous.path) %}navigation-unique{% endif %}" aria-label="Next page: {{ page.next.title }}">
                     <i class="fa fa-angle-right"></i>
                 </a>
                 {% endif %}
             {% endblock %}
         {% endblock %}
     </div>
+
+    <script>
+        var gitbook = gitbook || [];
+        gitbook.push(function() {
+        gitbook.page.hasChanged({{ template.getJSContext()|dump|safe }});
+        setTimeout(function(){
+           window._rePostionVersion()
+        },100);
+        });
+    </script>
 </div>
 {% endblock %}