diff --git a/README.zh-CN.md b/README.zh-CN.md new file mode 100644 index 0000000..bdb1e26 --- /dev/null +++ b/README.zh-CN.md @@ -0,0 +1,89 @@ +[English](https://github.com/rubickCenter/rubick/blob/master/README.md) | 简体中文 + + +
+ +
+ + +
+

Rubick

+ + release + + release + + + building + + + npm + + + star + + + 码云 + +
+ + +基于 electron 的开源工具箱，自由集成丰富插件，打造极致的桌面端效能工具。Rubick(拉比克) 是 dota 里面的英雄之一，其核心技能是插件化使用其他英雄的技能，用完即走。非常符合本工具的设计理念，所以取名 Rubick。 + +## 安装包 +* [Rubick Mac OS](https://github.com/rubickCenter/rubick/releases) +* [Rubick Windows](https://github.com/rubickCenter/rubick/releases) + +## 支持能力 +- [x] 基于 npm 包模式的插件管理，安装插件和安装 npm 包一样简单 +- [x] 支持系统插件，只要在 rubick 运行时，插件可以随时使用 +- [x] 支持全局快捷键设置 +- [x] 支持搜索本地已安装 app 或 偏好设置 +- [x] 支持 MacOS +- [x] 支持 Windows + + +## 使用文档 + +[Rubick Docs](https://rubickCenter.github.io/rubick/) + + +## 目前支持能力 +### 1. 搜索系统应用 +支持拼音和缩写来搜索系统安装应用： + +![](https://p6-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/ba363e8f60f540e6a5c365c4317c4413~tplv-k3u1fbpfcp-watermark.image) + +### 2. UI类插件安装 +点击搜索框右侧 `rubick` 图标，进入插件市场，选择所需插件，点击下载按钮即可下载，下载完成后在已安装 tab 下可以找到安装插件。 +安装完成后，输入插件呼起命令即可使用对应插件： + +![](https://p1-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/7ae45c7ede1f4e3bb7d35ae845e60b64~tplv-k3u1fbpfcp-watermark.image) + +### 3. 系统类插件安装 +系统插件安装方式和UI类一样，在插件市场选择`系统分类`，寻找适合自己的系统插件安装即可。 + +``` +系统插件安装成功后，需要重启 rubick 才能生效 +``` + +### 4. 输入框聚焦自动根据剪切板内容匹配插件 +在 `rubick` 内搜索`偏好设置`，然后开启`自动粘贴` 功能，即可匹配剪切板内容自动匹配适合插件进行使用。 + +![](https://p1-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/01ef50fbfa064ba9a88bebe1531eacd4~tplv-k3u1fbpfcp-watermark.image) + +### 更多功能 +如果您还需要更多功能，欢迎来这里给我们提建议：[issues](https://github.com/rubickCenter/rubick/issues) 。 +有价值的想法我们会加入到后期的开发当中。同时也欢迎一起加入共建。 + +## 贡献 +This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)]. + +## 反馈 +对本项目有兴趣或者想要交流学习的同学可以扫码加下面的微信，备注 rubick，帮助我们更好的成长： + +![image](https://user-images.githubusercontent.com/21073039/127327603-9796f246-ee4b-4950-a69d-ce3205ec9569.png) + +## License +This project is licensed under the MIT License - see the [LICENSE.md](https://github.com/rubickCenter/rubick/blob/master/LICENSE) file for details. + diff --git a/deploy-doc.sh b/deploy-doc.sh index 9204c25..f0780f4 100755 --- a/deploy-doc.sh +++ b/deploy-doc.sh @@ -19,6 +19,6 @@ git commit -m 'deploy' # git push -f git@github.com:/.github.io.git master # 如果发布到 https://.github.io/ -git push -f git@github.com:rubickCenter/rubick2.git master:gh-pages +git push -f git@github.com:rubickCenter/rubick.git master:gh-pages cd - diff --git a/docs/docs/.vuepress/config.js b/docs/docs/.vuepress/config.js index 587234e..aa092fb 100644 --- a/docs/docs/.vuepress/config.js +++ b/docs/docs/.vuepress/config.js @@ -1,7 +1,7 @@ module.exports = { title: 'Rubick', description: '你的开源桌面插件应用', - base: '/rubick2/', + base: '/rubick/', themeConfig: { themeColor: { blue: "#2196f3", @@ -30,7 +30,7 @@ module.exports = { } ], // 假定是 GitHub. 同时也可以是一个完整的 GitLab URL - repo: 'https://github.com/rubickCenter/rubick2', + repo: 'https://github.com/rubickCenter/rubick', // 自定义仓库链接文字。默认从 `themeConfig.repo` 中自动推断为 // "GitHub"/"GitLab"/"Bitbucket" 其中之一，或是 "Source"。 repoLabel: 'Github', diff --git a/docs/docs/guide/README.md b/docs/docs/guide/README.md index f0aeeaa..bf6d592 100644 --- a/docs/docs/guide/README.md +++ b/docs/docs/guide/README.md @@ -10,7 +10,7 @@ rubick 之前的插件管理，依托于云服务器存储，我们需要为服 [windows 下安装 nodejs 方法](https://juejin.cn/post/6892790243687137287) ## 下载 rubick -[rubick 下载安装地址](https://github.com/rubickCenter/rubick2/releases) +[rubick 下载安装地址](https://github.com/rubickCenter/rubick/releases) macos 选择 `pkg` 文件，windows 选择 `exe` 文件。 安装完成后打开 rubick 即可看到主搜索界面： @@ -45,5 +45,5 @@ macos 选择 `pkg` 文件，windows 选择 `exe` 文件。 ![](https://p1-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/01ef50fbfa064ba9a88bebe1531eacd4~tplv-k3u1fbpfcp-watermark.image) ### 更多功能 -如果您还需要更多功能，欢迎来这里给我们提建议：[issues](https://github.com/rubickCenter/rubick2/issues) 。 +如果您还需要更多功能，欢迎来这里给我们提建议：[issues](https://github.com/rubickCenter/rubick/issues) 。 有价值的想法我们会加入到后期的开发当中。同时也欢迎一起加入共建。