docs: update

qunarcorp · Oct 18, 2018 · 8dc0505 · 8dc0505
1 parent 4fbedd8
commit 8dc0505
Show file tree

Hide file tree

Showing 15 changed files with 200 additions and 27 deletions.
diff --git a/_site/documents/course.html b/_site/documents/course.html
@@ -15,10 +15,11 @@ <h2 id="配置">配置</h2>
             <span class="token property">"user"</span><span class="token operator">:</span> <span class="token string">"xxx"</span><span class="token punctuation">,</span> // 微信用户名
             <span class="token property">"pass"</span><span class="token operator">:</span> <span class="token string">"xxx"</span> // 微信密码
         <span class="token punctuation">}</span><span class="token punctuation">,</span>
-        <span class="token property">"checkApp"</span><span class="token operator">:</span> <span class="token boolean">false</span> // 校验是否安装微信 APP
+        <span class="token property">"checkApp"</span><span class="token operator">:</span> <span class="token boolean">false</span> // 校验是否安装微信 APP 及其版本
     <span class="token punctuation">}</span>
 <span class="token punctuation">}</span>
 </code></pre>
+<p>注意：微信用户名必需使用<strong>微信号</strong>，禁止使用手机号</p>
 <p>QScan 官方提供 Modal，指定 <strong>扫码模式</strong>，目前只支持微信扫码：</p>
 <h3 id="配置-wx-default-微信扫码">wx-default (微信扫码)</h3>
 <table>

diff --git a/_site/documents/usage.md b/_site/documents/usage.md
@@ -17,7 +17,7 @@ QScan 扫码需要一个配置，这个配置可以写在 ```~/.qscanrc``` 文
             "user": "xxx", // 微信用户名
             "pass": "xxx" // 微信密码
         },
-        "checkApp": false // 校验是否安装微信 APP
+        "checkApp": false // 校验是否安装微信 APP 及其版本
     }
 }
 ```

diff --git a/_site/search_json.js b/_site/search_json.js
@@ -57,7 +57,7 @@ window.ydoc_plugin_search_json = {
         {
           "title": "配置",
           "url": "/documents/course.html#配置",
-          "content": "配置QScan 扫码需要一个配置，这个配置可以写在 ~/.qscanrc 文件中，也可以写在代码中，这个配置的格式如下：{    \"wx-default\": { // key 值为 Modal 名称\n        \"udid\": \"HICMHMZTTW8DFI59\", // 安卓设备 id，通过 adb service 命令查看\n        \"port\": \"4723\", // 端口号\n        \"opts\": {\n            \"user\": \"xxx\", // 微信用户名\n            \"pass\": \"xxx\" // 微信密码\n        },\n        \"checkApp\": false // 校验是否安装微信 APP\n    }\n}\nQScan 官方提供 Modal，指定 扫码模式，目前只支持微信扫码："
+          "content": "配置QScan 扫码需要一个配置，这个配置可以写在 ~/.qscanrc 文件中，也可以写在代码中，这个配置的格式如下：{    \"wx-default\": { // key 值为 Modal 名称\n        \"udid\": \"HICMHMZTTW8DFI59\", // 安卓设备 id，通过 adb service 命令查看\n        \"port\": \"4723\", // 端口号\n        \"opts\": {\n            \"user\": \"xxx\", // 微信用户名\n            \"pass\": \"xxx\" // 微信密码\n        },\n        \"checkApp\": false // 校验是否安装微信 APP 及其版本\n    }\n}\n注意：微信用户名必需使用微信号，禁止使用手机号QScan 官方提供 Modal，指定 扫码模式，目前只支持微信扫码："
         },
         {
           "title": "wx-default (微信扫码)",
@@ -95,9 +95,42 @@ window.ydoc_plugin_search_json = {
   "方案": [
     {
       "title": "开始之前",
-      "content": "在开始之前，请确定已经准备好了下列设备：一台 macOS 的设备，苹果电脑或者垃圾桶\n一台安卓设备，推荐使用红米5\n一个懒人支架，用于固定扫码设备\n安装 QScan 工具，使用 doctor 命令验证环境",
+      "content": "在开始之前，请确定已经准备好了下列设备和账号：一台 macOS 的设备，苹果电脑\n一台安卓设备，推荐使用红米5\n一个懒人支架，或者其他能够固定扫码设备的装置\n一个微信账号，由于用于扫码，因此最好是不常用的账号或小号（微信号首次登录新设备时，需要手动进行身份验证）\n",
       "url": "/usage/index.html",
-      "children": []
+      "children": [
+        {
+          "title": "验证环境",
+          "url": "/usage/index.html#验证环境",
+          "content": "验证环境设备准备好之后，请准备好下列软硬件环境：1. 手机状态 关闭锁屏，关闭自动息屏，息屏状态无法唤起 Appium 扫码\n 开启开发者模式\n 将手机与电脑相连，并将手机固定在电脑前\n2. 微信状态 确认账号是可登陆状态，首次登陆需要进行身份验证\n 禁用 X5 内核: 在微信中打开 debugtbs.qq.com, 在 tbs 调试页面中禁用内核（这是因为 Appium 无法获取基于 X5 内核页面中的元素，也就无法完成点击操作）\n3. 物理环境 确保扫码的环境不会出现强烈的光照或其他遮挡物，光照会引起反光影响扫码\n 尽量保证扫码设备不被人为干扰，例如使用围栏、警示标语等\n4. QScan 环境 阅读 安装依赖 和 教程 ，写好配置后使用 doctor 命令检查运行环境\n"
+        }
+      ]
+    },
+    {
+      "title": "快速起步",
+      "content": "确定你已经验证环境之后，这里是一个最简案例：使用 QScan 扫码登录微信开发者工具，使用命令行的方式调用扫码服务，请安装\b 微信开发者工具，",
+      "url": "/usage/quickstart.html",
+      "children": [
+        {
+          "title": "连接设备并启动",
+          "url": "/usage/quickstart.html#连接设备并启动",
+          "content": "连接设备并启动手机连接电脑，打开终端，执行 adb devices 查看该设备的 id\n使用 Appium 启动一个进程，并设置端口 (这里设置为4723)，启动后 Appium 即可控制手机：\nappium -U 3HX0217705004280 -p 4723"
+        },
+        {
+          "title": "填写配置",
+          "url": "/usage/quickstart.html#填写配置",
+          "content": "填写配置编辑 ~/.qscanrc 文件，填写配置vi ~/.qscanrc{    \"wx-default\": { // key 值为 Modal 名称\n        \"udid\": \"HICMHMZTTW8DFI59\", // 安卓设备 id，通过 adb service 命令查看\n        \"port\": \"4723\", // 端口号，这里设置为 4723\n        \"opts\": {\n            \"user\": \"xxx\", // 微信用户名\n            \"pass\": \"xxx\" // 微信密码\n        },\n        \"checkApp\": true // 校验是否安装微信 APP 及其版本 \n    }\n}\n"
+        },
+        {
+          "title": "检查运行环境",
+          "url": "/usage/quickstart.html#检查运行环境",
+          "content": "检查运行环境全局安装 QScan 后，执行 qscan doctor 检测上面的配置，确保所有的输出都是 ✔ SUCCESS"
+        },
+        {
+          "title": "",
+          "url": "/usage/quickstart.html#",
+          "content": ""
+        }
+      ]
     },
     {
       "title": "使用方案",

diff --git a/_site/usage/index.html b/_site/usage/index.html
@@ -1,16 +1,38 @@
-<!DOCTYPE html><html lang="zh-CN"><head><meta charSet="UTF-8"/><meta content="text/html; charset=utf-8" http-equiv="Content-Type"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1"/><meta name="apple-mobile-web-app-capable" content="yes"/><meta name="apple-mobile-web-app-status-bar-style" content="black"/><link rel="apple-touch-icon" sizes="180x180" href="../ydoc/images/apple-touch-icon.png"/><link rel="icon" type="image/png" sizes="32x32" href="../ydoc/images/favicon-32x32.png"/><link rel="icon" type="image/png" sizes="16x16" href="../ydoc/images/favicon-16x16.png"/><link rel="manifest" href="../ydoc/images/manifest.json"/><link rel="mask-icon" href="../ydoc/images/safari-pinned-tab.svg" color="#5bbad5"/><meta name="theme-color" content="#ffffff"/><meta http-equiv="Cache-Control" content="no-transform"/><meta http-equiv="Cache-Control" content="no-siteapp"/><title>开始之前-方案</title><link rel="stylesheet" href="../ydoc/styles/style.css"/><meta name="author" content="ymfe"/><meta name="keywords"/><meta name="description" content="qunar scan tool"/><meta id="releativePath" content=".."/><link rel="stylesheet" href="../ydoc/ydoc-plugin-search/search.css"/></head><body><div class="g-doc"><div class="m-aside"><div class="m-summary" id="js-menu"><div class="m-summary-content" id="js-menu-content"><div class="m-summary-block"><ul class="m-summary-list"><li class="item"><a href="" class="href">开始之前</a></li><li class="item"><div class="m-summary-block"><a href="scheme.html" class="href">使用方案</a><ul class="m-summary-list indent"><li class="item"><a href="scheme.html#%e5%ae%89%e8%a3%85%e5%b7%a5%e5%85%b7" class="href">最简案例</a></li><li class="item"><a href="scheme.html#%e5%ae%89%e8%a3%85-qscan" class="href">多设备</a></li></ul></div></li></ul></div></div></div><div class="m-summary-switch" id="js-summary-switch"><svg viewBox="0 0 926.23699 573.74994" version="1.1" x="0px" y="0px" width="15" height="15" class="bottom"><g transform="translate(904.92214,-879.1482)"><path d="m -673.67664,1221.6502 -231.2455,-231.24803 55.6165,-55.627 c 30.5891,-30.59485 56.1806,-55.627 56.8701,-55.627 0.6894,0 79.8637,78.60862 175.9427,174.68583 l 174.6892,174.6858 174.6892,-174.6858 c 96.079,-96.07721 175.253196,-174.68583 175.942696,-174.68583 0.6895,0 26.281,25.03215 56.8701,55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864-231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688,-104.0616 -231.873,-231.248 z" fill="#fff"></path></g></svg><svg viewBox="0 0 926.23699 573.74994" version="1.1" x="0px" y="0px" width="15" height="15" class="top"><g id="Page-1" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd"><g id="aaa" fill="#fff" fill-rule="nonzero"><path d="M231.2455,342.502 L0,111.25397 L55.6165,55.62697 C86.2056,25.03212 111.7971,-2.99999998e-05 112.4866,-2.99999998e-05 C113.176,-2.99999998e-05 192.3503,78.60859 288.4293,174.6858 L463.1185,349.3716 L637.8077,174.6858 C733.8867,78.60859 813.060896,-2.99999997e-05 813.750396,-2.99999997e-05 C814.439896,-2.99999997e-05 840.031396,25.03212 870.620496,55.62697 L926.236996,111.25397 L694.9915,342.502 C567.8065,469.6884 463.4636,573.75 463.1185,573.75 C462.7734,573.75 358.4305,469.6884 231.2455,342.502 Z" id="Shape" transform="translate(463.118498, 286.874985) scale(1, -1) translate(-463.118498, -286.874985) "></path></g></g></svg></div></div><div class="m-main" id="js-panel"><header class="m-header" id="js-header"><div class="m-header-title js-logo"><a href="../index.html" target="_self"><img class="logo" width="36" src="../ydoc/images/[email protected]"/><h6 class="name">QScan</h6></a></div><div><div class="m-search">
+<!DOCTYPE html><html lang="zh-CN"><head><meta charSet="UTF-8"/><meta content="text/html; charset=utf-8" http-equiv="Content-Type"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1"/><meta name="apple-mobile-web-app-capable" content="yes"/><meta name="apple-mobile-web-app-status-bar-style" content="black"/><link rel="apple-touch-icon" sizes="180x180" href="../ydoc/images/apple-touch-icon.png"/><link rel="icon" type="image/png" sizes="32x32" href="../ydoc/images/favicon-32x32.png"/><link rel="icon" type="image/png" sizes="16x16" href="../ydoc/images/favicon-16x16.png"/><link rel="manifest" href="../ydoc/images/manifest.json"/><link rel="mask-icon" href="../ydoc/images/safari-pinned-tab.svg" color="#5bbad5"/><meta name="theme-color" content="#ffffff"/><meta http-equiv="Cache-Control" content="no-transform"/><meta http-equiv="Cache-Control" content="no-siteapp"/><title>开始之前-方案</title><link rel="stylesheet" href="../ydoc/styles/style.css"/><meta name="author" content="ymfe"/><meta name="keywords"/><meta name="description" content="qunar scan tool"/><meta id="releativePath" content=".."/><link rel="stylesheet" href="../ydoc/ydoc-plugin-search/search.css"/></head><body><div class="g-doc"><div class="m-aside"><div class="m-summary" id="js-menu"><div class="m-summary-content" id="js-menu-content"><div class="m-summary-block"><ul class="m-summary-list"><li class="item"><div class="m-summary-block"><a href="" class="href">开始之前</a><ul class="m-summary-list indent"><li class="item"><a href="index.html#%e9%aa%8c%e8%af%81%e7%8e%af%e5%a2%83" class="href">验证环境</a></li></ul></div></li><li class="item"><a href="quickstart.html" class="href">快速起步</a></li></ul></div><div class="m-summary-block"><ul class="m-summary-list"><li class="item"><a href="scheme.html" class="href">使用方案</a></li><li class="item"><a href="scheme.html#%e5%ae%89%e8%a3%85-qscan" class="href">多设备</a></li></ul></div></div></div><div class="m-summary-switch" id="js-summary-switch"><svg viewBox="0 0 926.23699 573.74994" version="1.1" x="0px" y="0px" width="15" height="15" class="bottom"><g transform="translate(904.92214,-879.1482)"><path d="m -673.67664,1221.6502 -231.2455,-231.24803 55.6165,-55.627 c 30.5891,-30.59485 56.1806,-55.627 56.8701,-55.627 0.6894,0 79.8637,78.60862 175.9427,174.68583 l 174.6892,174.6858 174.6892,-174.6858 c 96.079,-96.07721 175.253196,-174.68583 175.942696,-174.68583 0.6895,0 26.281,25.03215 56.8701,55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864-231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688,-104.0616 -231.873,-231.248 z" fill="#fff"></path></g></svg><svg viewBox="0 0 926.23699 573.74994" version="1.1" x="0px" y="0px" width="15" height="15" class="top"><g id="Page-1" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd"><g id="aaa" fill="#fff" fill-rule="nonzero"><path d="M231.2455,342.502 L0,111.25397 L55.6165,55.62697 C86.2056,25.03212 111.7971,-2.99999998e-05 112.4866,-2.99999998e-05 C113.176,-2.99999998e-05 192.3503,78.60859 288.4293,174.6858 L463.1185,349.3716 L637.8077,174.6858 C733.8867,78.60859 813.060896,-2.99999997e-05 813.750396,-2.99999997e-05 C814.439896,-2.99999997e-05 840.031396,25.03212 870.620496,55.62697 L926.236996,111.25397 L694.9915,342.502 C567.8065,469.6884 463.4636,573.75 463.1185,573.75 C462.7734,573.75 358.4305,469.6884 231.2455,342.502 Z" id="Shape" transform="translate(463.118498, 286.874985) scale(1, -1) translate(-463.118498, -286.874985) "></path></g></g></svg></div></div><div class="m-main" id="js-panel"><header class="m-header" id="js-header"><div class="m-header-title js-logo"><a href="../index.html" target="_self"><img class="logo" width="36" src="../ydoc/images/[email protected]"/><h6 class="name">QScan</h6></a></div><div><div class="m-search">
       <div class="icon">&#xf0fd;</div>
       <input type="text" class="input js-input" placeholder="搜索" />
       <div class="m-search-result js-search-result"></div>
     </div></div><nav class="m-header-nav js-nav"><ul class="m-header-items"><li class="item "><a class="href" href="../documents/index.html">文档</a></li><li class="item active"><a class="href" href="">方案</a></li><li class="item "><a class="href" href="../experience/index.html">前车之鉴</a></li></ul></nav><div id="js-nav-btn" class="m-header-btn ui-font-ydoc"></div></header><div class="m-content" id="js-content"><div id="markdown-body" class="m-content-container markdown-body"><h1>开始之前</h1>
-<p><strong>在开始之前，请确定已经准备好了下列设备：</strong></p>
+<p><strong>在开始之前，请确定已经准备好了下列设备和账号：</strong></p>
 <ul>
-<li>一台 macOS 的设备，苹果电脑或者垃圾桶</li>
+<li>一台 macOS 的设备，苹果电脑</li>
 <li>一台安卓设备，推荐使用红米5</li>
-<li>一个懒人支架，用于固定扫码设备</li>
+<li>一个懒人支架，或者其他能够固定扫码设备的装置</li>
+<li>一个微信账号，由于用于扫码，因此最好是不常用的账号或小号（微信号首次登录新设备时，需要手动进行身份验证）</li>
 </ul>
-<p><strong>安装 QScan 工具，使用 doctor 命令验证环境</strong></p>
-</div><div class="m-content-container m-paging"><div class="m-paging-next m-paging-item"><a href="scheme.html" class="href">使用方案<span class="ui-font-ydoc"></span></a></div></div></div></div></div><div></div><script>
+<h2 id="验证环境">验证环境</h2>
+<p>设备准备好之后，请准备好下列软硬件环境：</p>
+<h4>1. 手机状态</h4>
+<ul class="contains-task-list">
+<li class="task-list-item"><input class="task-list-item-checkbox" checked disabled type="checkbox"> 关闭锁屏，关闭自动息屏，息屏状态无法唤起 Appium 扫码</li>
+<li class="task-list-item"><input class="task-list-item-checkbox" checked disabled type="checkbox"> 开启开发者模式</li>
+<li class="task-list-item"><input class="task-list-item-checkbox" checked disabled type="checkbox"> 将手机与电脑相连，并将手机固定在电脑前</li>
+</ul>
+<h4>2. 微信状态</h4>
+<ul class="contains-task-list">
+<li class="task-list-item"><input class="task-list-item-checkbox" checked disabled type="checkbox"> 确认账号是可登陆状态，首次登陆需要进行身份验证</li>
+<li class="task-list-item"><input class="task-list-item-checkbox" checked disabled type="checkbox"> 禁用 X5 内核: 在微信中打开 debugtbs.qq.com, 在 tbs 调试页面中禁用内核（这是因为 Appium 无法获取基于 X5 内核页面中的元素，也就无法完成点击操作）</li>
+</ul>
+<h4>3. 物理环境</h4>
+<ul class="contains-task-list">
+<li class="task-list-item"><input class="task-list-item-checkbox" checked disabled type="checkbox"> 确保扫码的环境不会出现强烈的光照或其他遮挡物，光照会引起反光影响扫码</li>
+<li class="task-list-item"><input class="task-list-item-checkbox" checked disabled type="checkbox"> 尽量保证扫码设备不被人为干扰，例如使用围栏、警示标语等</li>
+</ul>
+<h4>4. QScan 环境</h4>
+<ul class="contains-task-list">
+<li class="task-list-item"><input class="task-list-item-checkbox" checked disabled type="checkbox"> 阅读 <a href="../documents/install.html">安装依赖</a> 和 <a href="../documents/course.html">教程</a> ，写好配置后使用 <code>doctor</code> 命令检查运行环境</li>
+</ul>
+</div><div class="m-content-container m-paging"><div class="m-paging-next m-paging-item"><a href="quickstart.html" class="href">快速起步<span class="ui-font-ydoc"></span></a></div></div></div></div></div><div></div><script>
     var $content = document.getElementById('js-content');
     var $summaryItems = Array.prototype.slice.call(document.querySelectorAll('#js-menu .href'));
     var $menu = document.getElementById('js-menu');