diff --git a/README.md b/README.md index 5fe7890..fe91953 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -

中文 | English

+

English | 中文

@@ -15,16 +15,16 @@ GitHub closed issues -
很简单的用 Rust 打包网页生成很小的桌面 App，支持 Mac / Windows / Linux 系统，常用包下载、命令行一键打包、定制开发 可见下面文档，也欢迎去 讨论区 交流。
+
A simple way to package a web page to desktop application, support Mac / Windows / Linux. App download、command line packaging、custom development can be found in the following document. Welcome to Discussions to see if there have anything you're interesting.
-## 特征 +## Features -🏂 **小**：相比传统的 Electron 套壳打包，要小将近 40 倍，不到 3M。 -😂 **快**：Pake 的底层使用的 Rust Tauri 框架，性能体验较 JS 框架要轻快不少，内存小很多。 -🩴 **特**：不是单纯打包，实现了快捷键的透传、沉浸式的窗口、拖动、样式改写、去广告、产品的极简风格定制。 -🐶 **玩**：只是一个很简单的小玩具，用 Rust 替代之前套壳网页打包的老思路，其实 PWA 也很好。 +🏂 **Small**：Nearly 40 times smaller than Electron package, less than 3M. +😂 **Fast**：Using the Rust Tauri, it`s much lighter and faster than JS. +🩴 **Special**：Not just packaged, with shortcut pass-through, immersive windows, minimalist customization of products. +🐶 **Toy**：Just a simple way to play with Rust instead of the old idea of shelling the web. -## 常用包下载 +## Download @@ -94,85 +94,84 @@
- -🏂 更多应用如 Flomo / 语雀 / RunCode 可去 Release下载，此外点击可展开快捷键说明 +🏂More applications such as Flomo / YuQue / RunCode can be downloaded from Release, click to expand shortcut descriptions
-| Mac | Windows/Linux | 功能 | -| --------------------------- | ------------------------------ | ------------------ | -| ⌘ + [ | Ctrl + ← | 返回上一个页面 | -| ⌘ + ] | Ctrl + → | 去下一个页面 | -| ⌘ + ↑ | Ctrl + ↑ | 自动滚动到页面顶部 | -| ⌘ + ↓ | Ctrl + ↓ | 自动滚动到页面底部 | -| ⌘ + r | Ctrl + r | 刷新页面 | -| ⌘ + w | Ctrl + w | 隐藏窗口，非退出 | -| ⌘ + - | Ctrl + - | 缩小页面 | -| ⌘ + + | Ctrl + + | 放大页面 | -| ⌘ + = | Ctrl + = | 放大页面 | -| ⌘ + 0 | Ctrl + 0 | 重置页面缩放 | +| Mac | Windows/Linux | Function | +| --------------------------- | ------------------------------ | ----------------------------- | +| ⌘ + [ | Ctrl + ← | Return to the previous page | +| ⌘ + ] | Ctrl + → | Go to the next page | +| ⌘ + ↑ | Ctrl + ↑ | Auto scroll to top of page | +| ⌘ + ↓ | Ctrl + ↓ | Auto scroll to bottom of page | +| ⌘ + r | Ctrl + r | Refresh Page | +| ⌘ + w | Ctrl + w | Hide window, not quite | +| ⌘ + - | Ctrl + - | Zoom out the page | +| ⌘ + + | Ctrl + + | Zoom in the page | +| ⌘ + = | Ctrl + = | Zoom in the Page | +| ⌘ + 0 | Ctrl + 0 | Reset the page zoom | -此外还支持双击头部进行全屏切换，拖拽头部进行移动窗口，Mac 用户支持手势方式返回和去下一页，还有其他需求，欢迎提过来。 +In addition, it supports double-clicking the head to switch to full screen, Mac users support gesture mode to return and go to the next page, and dragging the head to move the window.
-## 开始之前 +## Before you start -1. **小白用户**：使用 「常用包下载」 方式来把玩 Pake 的能力，可去 [讨论群](https://github.com/tw93/Pake/discussions) 寻求帮助，也可试试 [Action](https://github.com/tw93/Pake/wiki/GitHub-Actions-%E5%9C%A8%E7%BA%BF%E7%BC%96%E8%AF%91%E5%A4%9A%E7%B3%BB%E7%BB%9F%E7%89%88%E6%9C%AC) 方式。 -2. **开发用户**：使用 「命令行一键打包」，对 Mac 比较友好，Windows / Linux 需折腾下 [环境配置](https://tauri.app/v1/guides/getting-started/prerequisites)。 -3. **折腾用户**：假如你前端和 Rust 都会，那可试试下面的 「[定制开发](#定制开发)」，可深度二次开发定制你的功能。 +1. **Beginner users**: Use the 「Download」 method to play with Pake's capabilities, go to discussion groups for help, or try the [Github Actions](https://github.com/tw93/Pake/wiki/GitHub-Actions-Online-Compilation-Multi-system-Version) method. +2. **Development users**: Use 「command line packing」, Mac friendly, Windows/Linux requires a bit of tinkering, but both require environment [configuration](https://tauri.app/v1/guides/getting-started/prerequisites). +3. **Hacker users**: If you know both front-end and rust, try the following custom development, which allows you to customize your features with deep secondary development. -## 命令行一键打包 +## Command line packing

-**Pake 提供了命令行工具，可以更快捷方便地一键自定义打你需要的包，详细可见 [文档](./bin/README.md)。** +**Pake provides a command line tool that makes it quicker and easier to customize the packages you need, as detailed in [documentation](./.github/workflows/docs/README_EN.md).** ```bash -// 使用 npm 进行安装 +// Install with npm npm install -g pake-cli -// 命令使用 +// Command usage pake url [options] -// 随便玩玩，首次由于安装环境会有些慢，后面就快了 +// Play casually, first time due to the installation environment will be a little slow pake https://weekly.tw93.fun --name Weekly --transparent ``` -假如你不太会使用命令行，或许使用 **GitHub Actions 在线编译多系统版本** 是一个不错的选择，可查看 [文档](https://github.com/tw93/Pake/wiki/GitHub-Actions-%E5%9C%A8%E7%BA%BF%E7%BC%96%E8%AF%91%E5%A4%9A%E7%B3%BB%E7%BB%9F%E7%89%88%E6%9C%AC)。 +If you are a little white who doesn't know how to use the command line, a good option is to use **GitHub Actions online compilation**, see the [tutorial](https://github.com/tw93/Pake/wiki/GitHub-Actions-Online-Compilation-Multi-system-Version). -## 定制开发 +## Development -开始前请确保电脑已经安装了 Rust `>=1.63` 和 Node `>=16 如 16.18.1` 的环境，此外需参考 [Tauri 文档](https://tauri.app/v1/guides/getting-started/prerequisites) 快速配置好环境才可以开始使用，假如你太不懂，使用上面的命令行打包会更加合适。 +Before starting, make sure that the computer has installed the Rust `>=1.63` and Node `>=16 as 16.18.1` environment，refer to the [Tauri documentation](https://tauri.app/v1/guides/getting-started/prerequisites) to quickly configure your environment before you start. If you don't understand, it will be more appropriate to use the above command line to pack with one click. ```sh -// 安装依赖 +// Install Dependencies npm i -// 本地开发 +// Local development npm run dev -// 本地调试 +// Local debug npm run dev:debug -// 打包应用 +// Pack application npm run build ``` -## 高级使用 +## Advanced use -1. 代码结构可参考 [文档](https://github.com/tw93/Pake/wiki/Pake-%E7%9A%84%E4%BB%A3%E7%A0%81%E7%BB%93%E6%9E%84%E8%AF%B4%E6%98%8E)，便于你在开发前了解更多。 -2. 修改 src-tauri 目录下的 `tauri.conf.json`以及 `tauri.xxx.conf.json` 中的 url、productName、icon、identifier 这 4 个字段，其中 icon 可以从 icons 目录选择一个，也可以去 [macOSicons](https://macosicons.com/#/) 下载符合效果的。 -3. 关于窗口属性设置，可以在 `tauri.conf.json` 修改 windows 属性对应的 `width/height`，fullscreen 是否全屏，resizable 是否可以调整大小，假如想适配 Mac 沉浸式头部，可以将 transparent 设置成 `true`，找到 Header 元素加一个 padding-top 样式即可，不想适配改成 `false` 也行。 -4. 此外样式改写、屏蔽广告、逻辑代码注入、容器消息通信、自定义快捷键可见 [高级用法](https://github.com/tw93/Pake/wiki/Pake-%E7%9A%84%E9%AB%98%E7%BA%A7%E7%94%A8%E6%B3%95)。 +1. The code structure can be referred to [Here](https://github.com/tw93/Pake/wiki/Description-of-Pake's-code-structure), it is convenient for you to learn more before development. +2. Modify the `tauri.conf.json` and `tauri.xxx.conf.json` in the `src-tauri` directory to include 4 fields `url, productName, icon, identifier`, icon can be selected from the `icons` directory or downloaded from [macOSicons](https://macosicons.com/#/) to match the product. +3. For window property settings, you can modify the `width/height` of the `windows` property in `tauri.conf.json`, whether it is `fullscreen`, whether it is `resizable`, If you want to adapt the immersive header under Mac, you can set `transparent` to `true` and then find header element and add the `padding-top` style. +4. About style rewriting, advertising shielding, js injection, container message communication, and user-defined shortcut keys, you can see [Advanced Usage of Make](https://github.com/tw93/Pake/wiki/Advanced-Usage-of-Make). ## 开发者 -Pake 的发展离不开这些 Hacker 们，一起贡献了大量能力，也欢迎关注他们 ❤️ +Pake's development can not be separated from these Hackers, together contributed a lot of ability, also welcome to follow them ❤️ @@ -301,9 +300,9 @@ Pake 的发展离不开这些 Hacker 们，一起贡献了大量能力，也欢
-## 支持 +## Support -1. 我有两只猫，一只叫汤圆，一只叫可乐，假如觉得 Pake 让你生活更美好，可以给汤圆可乐 喂罐头 🥩🍤。 -2. 如果你喜欢 Pake，可以在 Github Star，更欢迎 [推荐](https://twitter.com/intent/tweet?url=https://github.com/tw93/Pake&text=%23Pake%20%E4%B8%80%E4%B8%AA%E5%BE%88%E7%AE%80%E5%8D%95%E7%9A%84%E7%94%A8%20Rust%20%E6%89%93%E5%8C%85%E7%BD%91%E9%A1%B5%E7%94%9F%E6%88%90%20Mac%20App%20%E7%9A%84%E5%B7%A5%E5%85%B7%EF%BC%8C%E7%9B%B8%E6%AF%94%E4%BC%A0%E7%BB%9F%E7%9A%84%20Electron%20%E5%A5%97%E5%A3%B3%E6%89%93%E5%8C%85%EF%BC%8C%E5%A4%A7%E5%B0%8F%E8%A6%81%E5%B0%8F%E5%B0%86%E8%BF%91%2040%20%E5%80%8D%EF%BC%8C%E4%B8%80%E8%88%AC%202M%20%E5%B7%A6%E5%8F%B3%EF%BC%8C%E5%BA%95%E5%B1%82%E4%BD%BF%E7%94%A8Tauri%20%EF%BC%8C%E6%80%A7%E8%83%BD%E4%BD%93%E9%AA%8C%E8%BE%83%20JS%20%E6%A1%86%E6%9E%B6%E8%A6%81%E8%BD%BB%E5%BF%AB%E4%B8%8D%E5%B0%91%EF%BC%8C%E5%86%85%E5%AD%98%E5%B0%8F%E5%BE%88%E5%A4%9A%EF%BC%8C%E6%94%AF%E6%8C%81%E5%BE%AE%E4%BF%A1%E8%AF%BB%E4%B9%A6%E3%80%81Twitter%E3%80%81Youtube%E3%80%81RunCode%E3%80%81Flomo%E3%80%81%E8%AF%AD%E9%9B%80%E7%AD%89%EF%BC%8C%E5%8F%AF%E4%BB%A5%E5%BE%88%E6%96%B9%E4%BE%BF%E4%BA%8C%E6%AC%A1%E5%BC%80%E5%8F%91~) 给你志同道合的朋友使用。 -3. 可以关注我的 [Twitter](https://twitter.com/HiTw93) 获取到最新的 Pake 更新消息，也欢迎加入 [Telegram](https://t.me/miaoyan) 聊天群。 -4. 希望大伙玩的过程中有一种学习新技术的喜悦感，假如你发现有很适合做成桌面 App 的网页也很欢迎告诉我。 +1. I have two cats, one is called TangYuan, and one is called Coke, If you think Pake makes your life better, you can give my cats feed canned food 🥩🍤. +2. If you like Pake, you can star it in Github. Also welcome to [recommend Pake](https://twitter.com/intent/tweet?url=https://github.com/tw93/Pake&text=%23Pake%20-%20A%20simple%20Rust%20packaged%20web%20pages%20to%20generate%20Mac%20App%20tool,%20compared%20to%20traditional%20Electron%20package,%20the%20size%20of%20nearly%2040%20times%20smaller,%20generally%20about%202M,%20the%20underlying%20use%20of%20Tauri,%20performance%20experience%20than%20the%20JS%20framework%20is%20much%20lighter~) to your friends. +3. You can follow my [Twitter](https://twitter.com/HiTw93) to get the latest news of Pake, or join [Telegram](https://t.me/miaoyan) chat group. +4. I hope that you will enjoy playing with it. If you find a page that would be great for a Mac App, please let me know. diff --git a/README_CN.md b/README_CN.md new file mode 100644 index 0000000..6e36ff8 --- /dev/null +++ b/README_CN.md @@ -0,0 +1,309 @@ +

中文 | English

+

+ +

+

Pake

+
+ + twitter + + telegram + + GitHub downloads + + GitHub commit + + GitHub closed issues +
+
很简单的用 Rust 打包网页生成很小的桌面 App，支持 Mac / Windows / Linux 系统。常用包下载、命令行一键打包、定制开发 可见下面文档，也欢迎去 讨论区 交流。
+ +## 特征 + +🏂 **小**：相比传统的 Electron 套壳打包，要小将近 40 倍，不到 3M。 +😂 **快**：Pake 的底层使用的 Rust Tauri 框架，性能体验较 JS 框架要轻快不少，内存小很多。 +🩴 **特**：不是单纯打包，实现了快捷键的透传、沉浸式的窗口、拖动、样式改写、去广告、产品的极简风格定制。 +🐶 **玩**：只是一个很简单的小玩具，用 Rust 替代之前套壳网页打包的老思路，其实 PWA 也很好。 + +## 常用包下载 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
WeRead + Mac + Windows + Linux + Twitter + Mac + Windows + Linux +
LiZhi + Mac + Windows + Linux + YouTube + Mac + Windows + Linux +
Qwerty + Mac + Windows + Linux + Reference + Mac + Windows + Linux +
Library + Mac + Windows + Linux + ChatGPT + Mac + Windows + Linux +
+ +
+ +🏂 更多应用如 Flomo / 语雀 / RunCode 可去 Release下载，此外点击可展开快捷键说明 + +
+ +| Mac | Windows/Linux | 功能 | +| --------------------------- | ------------------------------ | ------------------ | +| ⌘ + [ | Ctrl + ← | 返回上一个页面 | +| ⌘ + ] | Ctrl + → | 去下一个页面 | +| ⌘ + ↑ | Ctrl + ↑ | 自动滚动到页面顶部 | +| ⌘ + ↓ | Ctrl + ↓ | 自动滚动到页面底部 | +| ⌘ + r | Ctrl + r | 刷新页面 | +| ⌘ + w | Ctrl + w | 隐藏窗口，非退出 | +| ⌘ + - | Ctrl + - | 缩小页面 | +| ⌘ + + | Ctrl + + | 放大页面 | +| ⌘ + = | Ctrl + = | 放大页面 | +| ⌘ + 0 | Ctrl + 0 | 重置页面缩放 | + +此外还支持双击头部进行全屏切换，拖拽头部进行移动窗口，Mac 用户支持手势方式返回和去下一页，还有其他需求，欢迎提过来。 + +
+ +## 开始之前 + +1. **小白用户**：使用 「常用包下载」 方式来把玩 Pake 的能力，可去 [讨论群](https://github.com/tw93/Pake/discussions) 寻求帮助，也可试试 [Action](https://github.com/tw93/Pake/wiki/GitHub-Actions-%E5%9C%A8%E7%BA%BF%E7%BC%96%E8%AF%91%E5%A4%9A%E7%B3%BB%E7%BB%9F%E7%89%88%E6%9C%AC) 方式。 +2. **开发用户**：使用 「命令行一键打包」，对 Mac 比较友好，Windows / Linux 需折腾下 [环境配置](https://tauri.app/v1/guides/getting-started/prerequisites)。 +3. **折腾用户**：假如你前端和 Rust 都会，那可试试下面的 「[定制开发](#定制开发)」，可深度二次开发定制你的功能。 + +## 命令行一键打包 + + + + +

+ +**Pake 提供了命令行工具，可以更快捷方便地一键自定义打你需要的包，详细可见 [文档](./bin/README.md)。** + +```bash +// 使用 npm 进行安装 +npm install -g pake-cli + +// 命令使用 +pake url [options] + +// 随便玩玩，首次由于安装环境会有些慢，后面就快了 +pake https://weekly.tw93.fun --name Weekly --transparent +``` + +假如你不太会使用命令行，或许使用 **GitHub Actions 在线编译多系统版本** 是一个不错的选择，可查看 [文档](https://github.com/tw93/Pake/wiki/GitHub-Actions-%E5%9C%A8%E7%BA%BF%E7%BC%96%E8%AF%91%E5%A4%9A%E7%B3%BB%E7%BB%9F%E7%89%88%E6%9C%AC)。 + +## 定制开发 + +开始前请确保电脑已经安装了 Rust `>=1.63` 和 Node `>=16 如 16.18.1` 的环境，此外需参考 [Tauri 文档](https://tauri.app/v1/guides/getting-started/prerequisites) 快速配置好环境才可以开始使用，假如你太不懂，使用上面的命令行打包会更加合适。 + +```sh +// 安装依赖 +npm i + +// 本地开发 +npm run dev + +// 本地调试 +npm run dev:debug + +// 打包应用 +npm run build + +``` + +## 高级使用 + +1. 代码结构可参考 [文档](https://github.com/tw93/Pake/wiki/Pake-%E7%9A%84%E4%BB%A3%E7%A0%81%E7%BB%93%E6%9E%84%E8%AF%B4%E6%98%8E)，便于你在开发前了解更多。 +2. 修改 src-tauri 目录下的 `tauri.conf.json`以及 `tauri.xxx.conf.json` 中的 url、productName、icon、identifier 这 4 个字段，其中 icon 可以从 icons 目录选择一个，也可以去 [macOSicons](https://macosicons.com/#/) 下载符合效果的。 +3. 关于窗口属性设置，可以在 `tauri.conf.json` 修改 windows 属性对应的 `width/height`，fullscreen 是否全屏，resizable 是否可以调整大小，假如想适配 Mac 沉浸式头部，可以将 transparent 设置成 `true`，找到 Header 元素加一个 padding-top 样式即可，不想适配改成 `false` 也行。 +4. 此外样式改写、屏蔽广告、逻辑代码注入、容器消息通信、自定义快捷键可见 [高级用法](https://github.com/tw93/Pake/wiki/Pake-%E7%9A%84%E9%AB%98%E7%BA%A7%E7%94%A8%E6%B3%95)。 + +## 开发者 + +Pake 的发展离不开这些 Hacker 们，一起贡献了大量能力，也欢迎关注他们 ❤️ + + + + + + + + + + + + + + + + + + + + + + + +
+ + tw93 +
+ Tw93 + + 		+ + Tlntin +
+ Tlntin + + 		+ + pan93412 +
+ Pan93412 + + 		+ + wanghanzhen +
+ Volare + + 		+ + liby +
+ Bryan Lee + + 		+ + essesoul +
+ Essesoul + + 		+ + m1911star +
+ Horus + +
+ + AielloChan +
+ Aiello + + 		+ + QingZ11 +
+ Steam + + 		+ + 2nthony +
+ 2nthony + + 		+ + nekomeowww +
+ Ayaka Neko + + 		+ + turkyden +
+ Dengju Deng + + 		+ + Fechin +
+ Fechin + + 		+ + princemaple +
+ Po Chen + +
+ + houhoz +
+ Hyzhao + + 		+ + liusishan +
+ Liusishan + + 		+ + piaoyidage +
+ Ranger + +
+ + +## 支持 + +1. 我有两只猫，一只叫汤圆，一只叫可乐，假如觉得 Pake 让你生活更美好，可以给汤圆可乐 喂罐头 🥩🍤。 +2. 如果你喜欢 Pake，可以在 Github Star，更欢迎 [推荐](https://twitter.com/intent/tweet?url=https://github.com/tw93/Pake&text=%23Pake%20%E4%B8%80%E4%B8%AA%E5%BE%88%E7%AE%80%E5%8D%95%E7%9A%84%E7%94%A8%20Rust%20%E6%89%93%E5%8C%85%E7%BD%91%E9%A1%B5%E7%94%9F%E6%88%90%20Mac%20App%20%E7%9A%84%E5%B7%A5%E5%85%B7%EF%BC%8C%E7%9B%B8%E6%AF%94%E4%BC%A0%E7%BB%9F%E7%9A%84%20Electron%20%E5%A5%97%E5%A3%B3%E6%89%93%E5%8C%85%EF%BC%8C%E5%A4%A7%E5%B0%8F%E8%A6%81%E5%B0%8F%E5%B0%86%E8%BF%91%2040%20%E5%80%8D%EF%BC%8C%E4%B8%80%E8%88%AC%202M%20%E5%B7%A6%E5%8F%B3%EF%BC%8C%E5%BA%95%E5%B1%82%E4%BD%BF%E7%94%A8Tauri%20%EF%BC%8C%E6%80%A7%E8%83%BD%E4%BD%93%E9%AA%8C%E8%BE%83%20JS%20%E6%A1%86%E6%9E%B6%E8%A6%81%E8%BD%BB%E5%BF%AB%E4%B8%8D%E5%B0%91%EF%BC%8C%E5%86%85%E5%AD%98%E5%B0%8F%E5%BE%88%E5%A4%9A%EF%BC%8C%E6%94%AF%E6%8C%81%E5%BE%AE%E4%BF%A1%E8%AF%BB%E4%B9%A6%E3%80%81Twitter%E3%80%81Youtube%E3%80%81RunCode%E3%80%81Flomo%E3%80%81%E8%AF%AD%E9%9B%80%E7%AD%89%EF%BC%8C%E5%8F%AF%E4%BB%A5%E5%BE%88%E6%96%B9%E4%BE%BF%E4%BA%8C%E6%AC%A1%E5%BC%80%E5%8F%91~) 给你志同道合的朋友使用。 +3. 可以关注我的 [Twitter](https://twitter.com/HiTw93) 获取到最新的 Pake 更新消息，也欢迎加入 [Telegram](https://t.me/miaoyan) 聊天群。 +4. 希望大伙玩的过程中有一种学习新技术的喜悦感，假如你发现有很适合做成桌面 App 的网页也很欢迎告诉我。 diff --git a/README_EN.md b/README_EN.md deleted file mode 100644 index e3081b9..0000000 --- a/README_EN.md +++ /dev/null @@ -1,177 +0,0 @@ -

中文 | English

-

- -

-

Pake

-
- - twitter - - telegram - - GitHub downloads - - GitHub commit - - GitHub closed issues -
-
A simple way to package a web page to desktop application, supporting Mac / Windows / Linux, app download、command line one-click packaging、custom development can be found in the following documents, welcome to Discussions to see if there have anything you're interesting.
- -## Features - -🏂 **Small**：Nearly 40 times smaller than Electron package, less than 3M. -😂 **Fast**：Using the Rust Tauri, the performance experience is much lighter and faster than JS, memory is much smaller. -🩴 **Special**：Not just packaged, with shortcut pass-through, immersive windows, minimalist customization of products. -🐶 **Toy**：Just a very simple little toy, a way to play with Rust instead of the old idea of shelling the web. - -## Download - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
WeRead - Mac - Windows - Linux - Twitter - Mac - Windows - Linux -
LiZhi - Mac - Windows - Linux - YouTube - Mac - Windows - Linux -
Qwerty - Mac - Windows - Linux - Reference - Mac - Windows - Linux -
Library - Mac - Windows - Linux - ChatGPT - Mac - Windows - Linux -
- -
-🏂 Expand the shortcut key - -
- -| Mac | Windows/Linux | Function | -| --------------------------- | ------------------------------ | ----------------------------- | -| ⌘ + [ | Ctrl + ← | Return to the previous page | -| ⌘ + ] | Ctrl + → | Go to the next page | -| ⌘ + ↑ | Ctrl + ↑ | Auto scroll to top of page | -| ⌘ + ↓ | Ctrl + ↓ | Auto scroll to bottom of page | -| ⌘ + r | Ctrl + r | Refresh Page | -| ⌘ + w | Ctrl + w | Hide window, not quite | -| ⌘ + - | Ctrl + - | Zoom out the page | -| ⌘ + + | Ctrl + + | Zoom in the page | -| ⌘ + = | Ctrl + = | Zoom in the Page | -| ⌘ + 0 | Ctrl + 0 | Reset the page zoom | - -In addition, it supports double-clicking the head to switch to full screen, Mac users support gesture mode to return and go to the next page, and dragging the head to move the window. - -
- -## Before you start - -1. **Beginner users**: Use the 「Download」 method to play with Pake's capabilities, go to discussion groups for help, or try the [Action](https://github.com/tw93/Pake/wiki/GitHub-Actions-Online-Compilation-Multi-system-Version) method. -2. **Development users**: Use 「command line packing」, Mac friendly, Windows/Linux requires a bit of tinkering, but both require environment [configuration](https://tauri.app/v1/guides/getting-started/prerequisites). -3. **Hacker users**: If you know both front-end and rust, try the following custom development, which allows you to customize your features with deep secondary development. - -## Command line packing - - - - -

- -**Pake provides a command line tool that makes it quicker and easier to customize the packages you need, as detailed in [documentation](./.github/workflows/docs/README_EN.md).** - -```bash -// Install with npm -npm install -g pake-cli - -// Command usage -pake url [options] - -// Play casually, first time due to the installation environment will be a little slow -pake https://weekly.tw93.fun --name Weekly --transparent -``` - -If you are a little white who doesn't know how to use the command line, a good option is to use **GitHub Actions online compilation**, see the [tutorial](https://github.com/tw93/Pake/wiki/GitHub-Actions-Online-Compilation-Multi-system-Version). - -## Development - -Before starting, make sure that the computer has installed the Rust `>=1.63` and Node `>=16 as 16.18.1` environment，refer to the [Tauri documentation](https://tauri.app/v1/guides/getting-started/prerequisites) to quickly configure your environment before you start. If you don't understand, it will be more appropriate to use the above command line to pack with one click. - -```sh -// Install Dependencies -npm i - -// Local development -npm run dev - -// Local debug -npm run dev:debug - -// Pack application -npm run build - -``` - -## Advanced use - -1. The code structure can be referred to [Here](https://github.com/tw93/Pake/wiki/Description-of-Pake's-code-structure), it is convenient for you to learn more before development. -2. Modify the `tauri.conf.json` and `tauri.xxx.conf.json` in the `src-tauri` directory to include 4 fields `url, productName, icon, identifier`, icon can be selected from the `icons` directory or downloaded from [macOSicons](https://macosicons.com/#/) to match the product. -3. For window property settings, you can modify the `width/height` of the `windows` property in `tauri.conf.json`, whether it is `fullscreen`, whether it is `resizable`, If you want to adapt the immersive header under Mac, you can set `transparent` to `true` and then find header element and add the `padding-top` style. -4. About style rewriting, advertising shielding, js injection, container message communication, and user-defined shortcut keys, you can see [Advanced Usage of Make](https://github.com/tw93/Pake/wiki/Advanced-Usage-of-Make). - -## Support - -1. I have two cats, one is called TangYuan, and one is called Coke, If you think Pake makes your life better, you can give my cats feed canned food 🥩🍤. -2. If you like Pake, you can star it in Github. Also welcome to [recommend Pake](https://twitter.com/intent/tweet?url=https://github.com/tw93/Pake&text=%23Pake%20-%20A%20simple%20Rust%20packaged%20web%20pages%20to%20generate%20Mac%20App%20tool,%20compared%20to%20traditional%20Electron%20package,%20the%20size%20of%20nearly%2040%20times%20smaller,%20generally%20about%202M,%20the%20underlying%20use%20of%20Tauri,%20performance%20experience%20than%20the%20JS%20framework%20is%20much%20lighter~) to your friends. -3. You can follow my [Twitter](https://twitter.com/HiTw93) to get the latest news of Pake, or join [Telegram](https://t.me/miaoyan) chat group. -4. I hope that you will enjoy playing with it. If you find a page that would be great for a Mac App, please let me know.