@quicktvui/ai 1.0.0

package/rules/.docs/zh-CN/css/style/font-style.md

@@ -0,0 +1,10 @@
+---
+title: FontStyle
+lang: zh-CN
+---
+
+# fontStyle
+
+| Name               | Description      | Type                         | Default |
+|--------------------|------------------|------------------------------| ------- |
+| fontStyle        | 字体样式          | ^[enum]`'normal' \| 'italic' `| `normal`|

package/rules/.docs/zh-CN/css/style/font-weight.md

@@ -0,0 +1,10 @@
+---
+title: FontWeight
+lang: zh-CN
+---
+
+# fontWeight
+
+| Name               | Description      | Type                         | Default |
+|--------------------|------------------|------------------------------| ------- |
+| fontWeight        | 字体粗细          | ^[number] \| ^[string]  | -|

package/rules/.docs/zh-CN/css/style/letter-spacing.md

@@ -0,0 +1,10 @@
+---
+title: LetterSpacing
+lang: zh-CN
+---
+
+# letterSpacing
+
+| Name               | Description      | Type                         | Default |
+|--------------------|------------------|------------------------------| ------- |
+| letterSpacing        | 文本字符间距          | ^[number]| -|

package/rules/.docs/zh-CN/css/style/opacity.md

@@ -0,0 +1,10 @@
+---
+title: Opacity
+lang: zh-CN
+---
+
+# opacity
+
+| Name               | Description      | Type                         | Default |
+|--------------------|------------------|------------------------------| ------- |
+| opacity        | 透明度          | ^[number]| -|

package/rules/.docs/zh-CN/css/style/text-decoration-color.md

@@ -0,0 +1,10 @@
+---
+title: TextDecorationColor
+lang: zh-CN
+---
+
+# textDecorationColor
+
+| Name               | Description      | Type                         | Default |
+|--------------------|------------------|------------------------------| ------- |
+| textDecorationColor        | 文本的修饰线颜色          | [color](/zh-CN/css/color/rgb)|- |

package/rules/.docs/zh-CN/css/style/text-decoration-line.md

@@ -0,0 +1,10 @@
+---
+title: TextDecorationLine
+lang: zh-CN
+---
+
+# textDecorationLine
+
+| Name               | Description      | Type                         | Default |
+|--------------------|------------------|------------------------------| ------- |
+| textDecorationLine        | 文本的修饰线类型          |^[enum]`'underline' \| 'line-through' \| 'none'`|- |

package/rules/.docs/zh-CN/css/style/text-decoration.md

@@ -0,0 +1,12 @@
+---
+title: TextDecoration
+lang: zh-CN
+---
+
+# textDecoration
+
+同 `textDecorationLine`
+
+| Name               | Description      | Type                         | Default |
+|--------------------|------------------|------------------------------| ------- |
+| textDecoration        | 边框颜色          | ^[enum]`'underline' \| 'line-through' \| 'none'`| -|

package/rules/.docs/zh-CN/css/style/tint-color.md

@@ -0,0 +1,10 @@
+---
+title: TintColor
+lang: zh-CN
+---
+
+# tintColor
+
+| Name               | Description      | Type                         | Default |
+|--------------------|------------------|------------------------------| ------- |
+| tintColor        | 对图片进行染色          | [color](/zh-CN/css/color/rgb)| - |

package/rules/.docs/zh-CN/css/style/visibility.md

@@ -0,0 +1,10 @@
+---
+title: Visibility
+lang: zh-CN
+---
+
+# visibility
+
+| Name               | Description      | Type                         | Default |
+|--------------------|------------------|------------------------------| ------- |
+| visibility        | 可见性          |^[enum]`'visible' \| 'hidden' `| `visible`|

package/rules/.docs/zh-CN/guide/basic/appendix.md

@@ -0,0 +1,35 @@
+---
+title: 'Appendix'
+lang: zh-CN
+---
+
+# 附录
+
+## 一、Node 和 Npm 版本切换教程
+
+* [点击查看 node 版本管理](/zh-CN/guide/node/install)
+* [点击查看 npm 版本管理](/zh-CN/guide/npm/install)
+
+## 二、各品牌电视和机顶盒打开 USB 调试方法
+
+### 1、[腾讯极光机顶盒](/zh-CN/guide/device/tencent)
+
+### 2、[小米机电视机 / 顶盒](/zh-CN/guide/device/xiaomi)
+
+### 3、[TCL电视](/zh-CN/guide/device/tcl)
+
+### 4、[海尔电视](/zh-CN/guide/device/haier)
+
+### 5、[海信电视](/zh-CN/guide/device/hisense)
+
+### 6、[创维电视](/zh-CN/guide/device/skyworth)
+
+### 7、[长虹电视](/zh-CN/guide/device/ch)
+
+### 8、[康佳电视](/zh-CN/guide/device/konka)
+
+### 9、[华为电视](/zh-CN/guide/device/huawei)
+
+### 10、[乐视电视](/zh-CN/guide/device/le)
+
+### 11、[天猫魔盒电视](/zh-CN/guide/device/tmall)

package/rules/.docs/zh-CN/guide/basic/dev-debug.md

@@ -0,0 +1,94 @@
+---
+title: 'Debug'
+lang: zh-CN
+---
+
+# 调试
+
+::: tip 调试常见问题
+
+* [点击查看调试常见问题](/zh-CN/guide/faq/dev-faq)
+  :::
+
+## 一、调试前置条件
+
+* ***调试设备已经连接***
+
+```shell
+quicktvui@MacBookPro ~ % adb connect 192.168.90.102
+connected to 192.168.90.102:5555
+
+quicktvui@MacBookPro ~ % adb devices
+List of devices attached
+192.168.90.102:5555	device
+```
+
+::: tip 连接设备并且打开 ADB 调试
+
+* [点击查看 打开 ADB 调试](/zh-CN/guide/basic/installation#三、配置安卓设备)
+
+* [点击查看 qui setup 详细信息](/zh-CN/tool/cli/setup)
+
+:::
+
+* ***本地服务已经启动***
+
+以下命令已执行并且无报错
+
+```shell
+npm run dev
+```
+
+::: tip npm run dev 常见问题
+
+* [点击查看调试常见问题](/zh-CN/guide/faq/dev-faq)
+
+:::
+
+<img src="/guide/basic/npm_run_dev.jpg" />
+
+## 二、加载测试代码
+
+用遥控器或鼠标点击`加载测试代码`按钮。
+
+::: warning 注意：如点击后，一直显示 加载中，执行 adb shell ping 192.168.x.x（电脑ip） 命令来判断电视端是否可以访问到电脑端。此步要确保电视端能访问到电脑端。
+:::
+
+<img src="/guide/basic/debug_runtime_ok.jpg" />
+
+## 三、查看LOG
+
+用 `chrome` 浏览器打开`http://localhost:38989/extensions/home.html?env=hippy`。
+
+<img src="/guide/basic/debug_chrome.jpg" />
+
+点击 `Elements` 查看元素
+
+<img src="/guide/basic/debug_chrome_elements.jpg" />
+
+点击 `Log` 查看日志
+
+<img src="/guide/basic/debug_chrome_logging.jpg" />
+
+## 四、常见错误码
+
+启动调试apk的时候，如果遇到错误，请参照错误码说明。
+
+<img src="/guide/basic/debug_err_code.png" />
+
+| 错误码              | 说明       |
+| ----------------- | ----------------- |
+| -101              | js代码出错，可以查看Chrome Log来定位        |
+| -102              | 加载测试代码失败,请查看debug服务是否运行，并能访问通 |
+| -103              | 引擎初始化失败，请退出重进 |
+| -1000             | 访问不通快应用后台，请检查网络 |
+| -1001             | 访问超时，请检查网络 |
+| -1002             | 服务端报错 |
+| -1003             | 获取应用信息出错 |
+| -1004             | 服务端未知错误 |
+| -2000             | rpk 下载地址出错 |
+| -2001             | rpk 下载失败 |
+| -3000             | rpk 解密失败 |
+| -3001             | rpk MD5不匹配 |
+| -3002             | rpk 解包失败 |
+| -4000             | 从Assets加载 rpk 失败 |

package/rules/.docs/zh-CN/guide/basic/dev-tools.md

@@ -0,0 +1,22 @@
+---
+title: 'Tools'
+lang: zh-CN
+---
+
+# 编辑工具设定
+
+你可以使用任意文本编辑器，结合我们的命令行工具来开发快应用。然而，我们推荐使用集成开发工具以获取更好的开发体验。这些集成开发工具提供了代码补全、代码高亮等辅助编辑的功能，以及为项目的运行和调试提供支持等。
+
+参考以下步骤安装使用 `VS Code` 或者 `WebStorm`。
+
+## 安装 WebStorm
+
+WebStorm 是JetBrains 出品的最智能 JavaScript IDE。
+
+最新版本的 [WebStorm](https://www.jetbrains.com/webstorm/)
+
+## 安装 VS Code
+
+VS Code 是一个可以运行和调试 Vue 的轻量级编辑器。
+
+最新版本的 [VS Code](https://code.visualstudio.com)

package/rules/.docs/zh-CN/guide/basic/installation.md

@@ -0,0 +1,144 @@
+---
+title: 'Installation'
+lang: zh-CN
+---
+
+# 安装和环境配置
+
+* ## 安装快应用开发环境
+
+### 一、安装 `Node`
+
+1. 下载安装`Node`
+
+::: tip 建议：下载安装使用 v20.0.0 以上版本
+
+[`根据你的系统选择相应版本下载最新的Node`](https://nodejs.org/en/)
+
+:::
+
+2. 检查`Node`是否安装成功
+
+在`cmd`里执行`node -v`查看node版本信息或者验证是否安装成功。
+
+  ```shell
+  node -v
+  v20.9.0
+  ```
+
+::: tip node 版本切换
+
+[点击查看 node 版本管理](/zh-CN/guide/node/install)
+
+:::
+
+### 二、安装 `npm`
+
+1. 下载安装`npm`
+
+   新版的`Node.js`已经集成了`npm`，所以安装`Node`的同时也安装好了`npm`。
+
+2. 检查`npm`是否安装成功
+
+   在`cmd`里执行`npm -v`查看`npm`版本信息：
+
+    ```shell
+    npm -v
+    10.1.0
+    ```
+
+::: tip npm 版本切换
+
+[点击查看 npm 版本管理](/zh-CN/guide/npm/install)
+
+:::
+
+### 三、配置安卓设备
+
+* 在 `Android` 设备上运行或测试快应用快应用之前，你需要一个运行 `Android 4.1（API 版本 16）` 或者更高的Android系统电视或者机顶盒设备。
+
+* 打开设备 ADB 调试功能。
+
+以小米电视为例，打开 ADB 调试功能：
+
+<img src="/guide/basic/device_usb_debug.png" />
+
+
+::: warning 注意：必须打开调试选项
+
+***[点击查看各品牌电视和机顶盒打开 USB 调试方法](/zh-CN/guide/basic/appendix#二、各品牌机顶盒打开USB调试方法)***
+
+在设备上打开 `Developer options` 和 `USB debugging`
+选项，你可以在 [Android documentation](https://developer.android.google.cn/studio/debug/dev-options) 上查看更详细的方法介绍。
+:::
+
+### 四、查看 Android 设备网络 IP 地址
+
+以小米电视为例，查看网络 IP 地址：
+
+***打开步骤：设置 ==>  网络设置 ==>  有线网络/无线网络 ==>  IPV4/IPV6网络地址***
+
+
+<img src="/guide/basic/device_ip_address.png" />
+
+-----------------------------------
+
+* ## 安装`Android`开发环境（非必需）
+
+### 一、安装 `Android Studio`
+
+1. 下载并安装[`Android Studio`](https://developer.android.google.cn/studio)。
+
+2. 运行`Android Studio`并进入`Android Studio Setup Wizard`，这会安装最新的`Android SDK`， `Android SDK Platform-Tools`
+   以及`Android SDK Build-Tools`，这些都是在开发快应用快应用时所需要的。
+
+### 二、配置 PATH 环境变量
+
+1. 找到 `Android SDK Platform-Tools`  路径。
+
+一般情况，`Android SDK Platform-Tools`   存放路径如下：
+
+* linux: `~/Android/Sdk`
+* macos: `~/Library/Android/sdk`
+* window: `%LOCALAPPDATA%\Android\sdk`
+
+2. 在环境变量中添加 `Android SDK Platform-Tools`  路径。
+
+```shell
+$ export PATH="$PATH:[PATH_OF_ANDROID_SDK_PLATFORM_TOOLS]/platform-tools"
+```
+
+3. 检查环境变量是否配置成功
+
+命令行执行命令 `adb`
+
+```shell
+adb
+Android Debug Bridge version 1.0.41
+Version 33.0.1-8253317
+```
+
+显示环境变量已经配置成功。
+
+### 三、配置 Android 设备
+
+在 `Android` 设备上运行或测试快应用快应用之前，你需要一个运行 `Android 4.1（API 版本 16）` 或者更高的Android系统电视或者机顶盒设备。
+
+1. 在设备上打开 `Developer options` 和 `USB debugging`
+   选项，你可以在 [Android documentation](https://developer.android.google.cn/studio/debug/dev-options) 上查看更详细的方法介绍。
+
+2. 通过 `adb connect 设备ip地址` 连接设备和电脑，如果在设备上弹出需要授权弹窗，允许授权以便让电脑能够访问你的开发设备。
+
+```shell
+adb connect 192.168.90.102
+connected to 192.168.90.102:5555
+```
+
+3. 在命令行中，使用 `adb devices` 命令来确保能够识别出你所连接的 Android 设备。
+
+```shell
+adb devices
+List of devices attached
+192.168.90.102:5555	device
+```
+

package/rules/.docs/zh-CN/guide/basic/language.md

@@ -0,0 +1,10 @@
+---
+title: 'Language'
+lang: zh-CN
+---
+
+# 开发语言
+
+QuickTVUI 完全由 ***Vue3 + TypeScript*** 语言开发。
+
+尽管支持 ***Vue2 + JavaScript*** 语言开发，但是我们推荐开发者使用 ***Vue3 + TypeScript*** 开发电视快应用。

package/rules/.docs/zh-CN/guide/basic/package-manager.md

@@ -0,0 +1,8 @@
+---
+title: 'PackageManager'
+lang: zh-CN
+---
+
+# 包管理器
+
+QuickTVUI支持 ***Yarn*** 和 ***NPM*** 两种常用的 JavaScript 包管理工具，开发者可以根据需求选择合适的包管理工具。

package/rules/.docs/zh-CN/guide/basic/quick-start.md

@@ -0,0 +1,150 @@
+---
+title: 'QuickStart'
+lang: zh-CN
+---
+
+# 快速开始
+
+::: tip 开发参考
+
+[QuickTVUI API 演示项目](/zh-CN/sample/api-demo)
+
+:::
+
+::: warning 注意：开始之前请确保电视或者机顶盒设备配置完成。
+
+* 连接到了网络
+* 打开了 ADB 调试功能
+
+[点击查看配置 Android 设备](/zh-CN/guide/basic/installation)
+
+:::
+
+### 一、安装并配置快应用运行环境（runtime apk）
+
+1. ***安装 [`@quicktvui/cli`](/zh-CN/tool/cli/introduction) 命令行工具***
+
+```shell
+npm install -g @quicktvui/cli@latest
+```
+
+2. ***配置快应用运行环境***
+
+* 执行[`qui setup`](/zh-CN/tool/cli/setup)按提示分步骤进行设置。
+
+```shell
+qui setup
+```
+
+::: tip 提示：查看 qui setup 详细内容
+[点击查看 qui setup 详细内容。](/zh-CN/tool/cli/setup)
+:::
+
+执行完毕后，会安装并配置好 runtime apk
+
+* 应用列表找到运行环境App：
+
+<img src="/guide/basic/runtime_app_install.png" />
+
+* 打开运行环境App：
+
+<img src="/guide/basic/runtime_app_running.png" />
+
+## 二、创建应用
+
+### 方式一、 用[`@quicktvui/cli`](/zh-CN/tool/cli/introduction)创建应用
+
+```shell
+qui create @quicktvui/quicktvui-template
+```
+
+::: tip 提示：查看 qui create 详细内容
+[点击查看 qui create 详细内容。](/zh-CN/tool/cli/create)
+:::
+
+<img src="/tool/cli/cli-create.jpg" />
+
+### 方式二、 以模板项目创建应用
+
+```shell
+git clone https://github.com/quicktvui/quicktvui-template.git
+```
+
+创建好的项目结构如下：
+
+<img width="400px"  src="/guide/basic/quick-start-project.png" />
+
+## 三、安装依赖库
+
+进入`quicktvui-template` 项目根目录下面执行如下命令：
+
+```shell
+yarn install
+```
+
+::: tip 推荐使用 yarn 进行安装包管理
+:::
+
+## 四、运行应用
+
+### 1. 进入`quicktvui-template` 项目根目录下面执行如下命令：
+
+打开`cmd`窗口执行
+
+```shell
+npm run dev
+```
+
+::: tip 提示：快应用调试APP显示电脑调试地址：192.168.x.x，并toast提示服务可用，则配置成功。
+:::
+
+::: warning 注意：如果服务启动后，还是提示服务不可用，可以排查下:
+
+* 电脑能否`ping`通电视`IP`。
+* 快应用调试APP显示的电脑的调试地址是否和电脑的IP地址一致。
+  :::
+
+### 2. 打开快应用运行环境查看模板应用
+
+点击屏幕的右侧的圆形（加载测试代码）按钮。
+
+
+<img src="/guide/basic/es_hello_world.png" />
+
+
+::: tip 调试常见问题
+[点击查看调试常见问题](/zh-CN/guide/faq/dev-faq)
+:::
+
+## 五、热重载 (Hot Reload)
+
+修改代码体验快应用代码热重载。
+
+1. 修改项目路径下`quicktvui-template/src/views/index.vue`文件， 把 `Hello World!` 修改为 `第一个大屏快应用`。
+2. 保存代码
+
+源文件：
+
+```vue
+
+<template>
+  <div class='index-root-view-css'>
+    <span class='index-root-text-view-css'>Hello World!</span>
+  </div>
+</template>
+```
+
+修改后的文件：
+
+```vue
+
+<template>
+  <div class='index-root-view-css'>
+    <span class='index-root-text-view-css'>第一个扩展屏快应用</span>
+  </div>
+</template>
+```
+
+查看效果：
+
+<img src="/guide/basic/es_hot_reload.png" />

package/rules/.docs/zh-CN/guide/changelog.md

@@ -0,0 +1,20 @@
+---
+title: 'Changelog'
+lang: zh-CN
+---
+
+<style scoped lang="scss">
+@at-root .hero-content {
+  padding: 32px;
+}
+</style>
+
+# Changelog
+
+QuickTVUI team uses **weekly** release strategy under normal circumstance, but critical bug fixes would require hotfix so the actual release number **could be** more than 1 per week.
+
+On this page you can only see the latest 30 records of our [Changelog](https://github.com/element-plus/element-plus/blob/dev/CHANGELOG.en-US.md).
+
+You can see the [Upgrade Changes](https://github.com/element-plus/element-plus/issues/15834) after version ^(2.5.0).
+
+<VpChangelog />

package/rules/.docs/zh-CN/guide/commit-examples.md

@@ -0,0 +1,90 @@
+---
+title: Commit Examples
+lang: zh-CN
+---
+
+# Commit Examples
+
+## Why this chapter exists
+
+Please refer to [Conventional Commits](https://www.conventionalcommits.org/) for more information.
+
+A good commit message enables us:
+
+1. To understand what the contributor is trying to do
+2. Automatically generates change log
+
+### Rule for writing commit message
+
+```md
+# (If applied, this commit will...) <subject> (Max 72 characters)
+
+# |<---- Using a Maximum Of 72 Characters ---->|
+
+# Explain why this change is being made
+
+# |<---- Try To Limit Each Line to a Maximum Of 72 Characters ---->|
+
+# Provide links or keys to any relevant tickets, articles or other resources
+
+# Use issues and merge requests' full URLs instead of short references,
+
+# as they are displayed as plain text outside of GitLab
+
+# --- COMMIT END ---
+
+# --------------------
+
+# Remember to
+
+# Capitalize the subject line
+
+# Use the imperative mood in the subject line
+
+# Do not end the subject line with a period
+
+# Subject must contain at least 3 words
+
+# Separate subject from body with a blank line
+
+# Commits that change 30 or more lines across at least 3 files should
+
+# describe these changes in the commit body
+
+# Do not use Emojis
+
+# Use the body to explain what and why vs. how
+
+# Can use multiple lines with "-" for bullet points in body
+
+# For more information: https://chris.beams.io/posts/git-commit/
+
+# --------------------
+```
+
+### Template for commit messages
+
+Below is a template commit message for your reference.
+
+```md
+feat(components): [button] I did something with button
+
+Blank between subject and body is expected.(period is expected)
+Describes your change in one line or multi-line.
+Capitalize your first letter when starting a new line
+Please do not exceeds 72 characters per line, because that would be harder to comprehend.
+
+- You can also add bullet list symbol for better layout
+```
+
+For the subject header, the format is:
+
+```
+[type](scope): [messages]
+```
+
+You can checkout the allowed values for **type** and **scope** in [commitlint.config.js](https://github.com/element-plus/element-plus/blob/c2ee36a7fc72b17742d43ecdff4e2912c416141d/commitlint.config.js#L57),
+
+### Useful links
+
+[Keeping git commit history clean](https://about.gitlab.com/blog/2018/06/07/keeping-git-commit-history-clean/)