📝 Refactoring documentation

This commit is contained in:
Tw93
2025-09-06 23:27:27 +08:00
parent 50d85fad52
commit e33f7f43e7
9 changed files with 358 additions and 252 deletions

View File

@@ -1,18 +1,19 @@
# Pake Documentation
<h4 align="right"><strong>English</strong> | <a href="README_CN.md">简体中文</a></h4>
Welcome to Pake documentation! Here you'll find comprehensive guides and documentation to help you start working with Pake as quickly as possible.
## User Guides
- **[CLI Usage](cli-usage.md)** | [中文](cli-usage_CN.md) - Command-line interface reference
- **[GitHub Actions](github-actions-usage.md)** | [中文](github-actions-usage_CN.md) - Build apps online without local setup
- **[Pake Action](pake-action.md)** - Use Pake as GitHub Action in your projects
- **[CLI Command Reference](cli-usage.md)** - Complete command-line parameters and basic usage
- **[GitHub Actions Online Build](github-actions-usage.md)** - Online build without local environment setup
- **[Pake Action Integration](pake-action.md)** - Use Pake as a GitHub Action in your projects
## Developer Guides
- **[Advanced Usage](advanced-usage.md)** | [中文](advanced-usage_CN.md) - Customization, development, and advanced features
- **[CLI Testing](cli-testing.md)** - Testing guide for CLI functionality
- **[Contributing](../CONTRIBUTING.md)** - How to contribute to Pake development
- **[Advanced Usage & Development](advanced-usage.md)** - Code customization, project structure, development environment setup and testing guides
- **[Contributing Guide](../CONTRIBUTING.md)** - How to contribute to Pake development
## Quick Links

23
docs/README_CN.md Normal file
View File

@@ -0,0 +1,23 @@
# Pake 文档
<h4 align="right"><a href="README.md">English</a> | <strong>简体中文</strong></h4>
欢迎使用 Pake 文档!在这里您可以找到全面的指南和文档,帮助您快速开始使用 Pake。
## 使用指南
- **[CLI命令参考](cli-usage_CN.md)** - 完整的命令行参数说明和基础用法
- **[GitHub Actions在线构建](github-actions-usage_CN.md)** - 无需本地环境的在线构建方式
- **[Pake Action集成](pake-action.md)** - 在你的项目中使用 Pake 作为 GitHub Action
## 开发指南
- **[高级用法与开发](advanced-usage_CN.md)** - 代码自定义、项目结构、开发环境配置和测试指南
- **[贡献指南](../CONTRIBUTING.md)** - 如何为 Pake 开发做贡献
## 快捷链接
- [主仓库](https://github.com/tw93/Pake)
- [发布页面](https://github.com/tw93/Pake/releases)
- [讨论区](https://github.com/tw93/Pake/discussions)
- [问题反馈](https://github.com/tw93/Pake/issues)

View File

@@ -1,5 +1,7 @@
# Advanced Usage
<h4 align="right"><strong>English</strong> | <a href="advanced-usage_CN.md">简体中文</a></h4>
Customize Pake apps with style modifications, JavaScript injection, and container communication.
## Style Customization
@@ -118,12 +120,49 @@ Understanding Pake's codebase structure will help you navigate and contribute ef
### Prerequisites
- Node.js ≥22.0.0 (recommended LTS, older versions ≥16.0.0 may work)
- Node.js ≥22.0.0 (recommended LTS, older versions ≥18.0.0 may work)
- Rust ≥1.89.0 (recommended stable, older versions ≥1.78.0 may work)
- Platform-specific build tools:
- **macOS**: Xcode Command Line Tools (`xcode-select --install`)
- **Windows**: Visual Studio Build Tools with MSVC
- **Linux**: `build-essential`, `libwebkit2gtk`, system dependencies
#### Platform-Specific Requirements
**macOS:**
- Xcode Command Line Tools: `xcode-select --install`
**Windows:**
- **CRITICAL**: Consult [Tauri prerequisites](https://tauri.app/start/prerequisites/) before proceeding
- Windows 10 SDK (10.0.19041.0) and Visual Studio Build Tools 2022 (≥17.2)
- Required redistributables:
1. Microsoft Visual C++ 2015-2022 Redistributable (x64)
2. Microsoft Visual C++ 2015-2022 Redistributable (x86)
3. Microsoft Visual C++ 2012 Redistributable (x86) (optional)
4. Microsoft Visual C++ 2013 Redistributable (x86) (optional)
5. Microsoft Visual C++ 2008 Redistributable (x86) (optional)
- **Windows ARM (ARM64) support**: Install C++ ARM64 build tools in Visual Studio Installer under "Individual Components" → "MSVC v143 - VS 2022 C++ ARM64 build tools"
**Linux (Ubuntu):**
```bash
sudo apt install libdbus-1-dev \
libsoup-3.0-dev \
libjavascriptcoregtk-4.1-dev \
libwebkit2gtk-4.1-dev \
build-essential \
curl \
wget \
file \
libxdo-dev \
libssl-dev \
libgtk-3-dev \
libayatana-appindicator3-dev \
librsvg2-dev \
gnome-video-effects \
gnome-video-effects-extra \
libglib2.0-dev \
pkg-config
```
### Installation
@@ -146,21 +185,117 @@ pnpm run dev
3. **Injection Logic**: Modify files in `src-tauri/src/inject/` for web customizations
4. **Testing**: Run `pnpm test` for comprehensive validation
#### Command Reference
- **Dev mode**: `pnpm run dev` (hot reload)
- **Build**: `pnpm run build`
- **Debug build**: `pnpm run build:debug`
- **CLI build**: `pnpm run cli:build`
### Testing
#### CLI Development
For CLI development with hot reloading, modify the `DEFAULT_DEV_PAKE_OPTIONS` configuration in `bin/defaults.ts`:
```typescript
export const DEFAULT_DEV_PAKE_OPTIONS: PakeCliOptions & { url: string } = {
...DEFAULT_PAKE_OPTIONS,
url: "https://weekly.tw93.fun/",
name: "Weekly",
};
```
Then run:
```bash
# Run all tests (unit + integration + builder)
pnpm test
pnpm run cli:dev
```
This script reads the configuration and packages the specified app in watch mode, with hot updates for `pake-cli` code changes.
### Testing Guide
Comprehensive CLI build test suite for validating multi-platform packaging functionality.
#### Running Tests
```bash
# Complete test suite (recommended)
pnpm test # Run full test suite including real build tests (8-12 minutes)
# Quick testing during development
pnpm test -- --no-build # Skip build tests, validate core functionality only (30 seconds)
# Build CLI for testing
pnpm run cli:build
```
#### 🚀 Complete Test Suite Includes
-**Unit Tests**: CLI commands, parameter validation, response time
-**Integration Tests**: Process management, file permissions, dependency resolution
-**Builder Tests**: Platform detection, architecture detection, file naming
-**Real Build Tests**: Complete GitHub.com app packaging validation
#### Test Details
**Unit Tests (6 tests)**
- Version command (`--version`)
- Help command (`--help`)
- URL validation (valid/invalid links)
- Parameter validation (number type checking)
- CLI response time (<2 seconds)
- Weekly URL accessibility
**Integration Tests (3 tests)**
- Process spawning and management
- File system permission checks
- Dependency package resolution validation
**Builder Tests (3 tests)**
- Platform detection (macOS/Windows/Linux)
- Architecture detection (Intel/ARM64)
- File naming pattern verification
**Real Build Tests (Focus)**
_macOS_: 🔥 Multi-architecture build (Universal binary)
- Compile Intel + Apple Silicon dual architecture
- Detect `.app` file generation: `GitHubMultiArch.app`
- Fallback detection: `src-tauri/target/universal-apple-darwin/release/bundle/macos/`
- Verify universal binary: `file` command architecture check
_Windows_: Single architecture build
- Detect EXE file: `src-tauri/target/x86_64-pc-windows-msvc/release/pake.exe`
- Detect MSI installer: `src-tauri/target/x86_64-pc-windows-msvc/release/bundle/msi/*.msi`
_Linux_: Single architecture build
- Detect DEB package: `src-tauri/target/release/bundle/deb/*.deb`
- Detect AppImage: `src-tauri/target/release/bundle/appimage/*.AppImage`
#### Release Build Testing
```bash
# Actual build testing (tests weread + twitter apps)
node ./tests/release.js
```
Real build of 2 application packages to verify complete packaging flow and release.yml logic.
#### Troubleshooting
- **CLI file not found**: Run `pnpm run cli:build`
- **Test timeout**: Build tests require extended time to complete
- **Build failures**: Check Rust toolchain with `rustup update`
- **Permission errors**: Ensure write permissions are available
Total: **13 tests** - all passing indicates CLI functionality is working properly. Recommend running `pnpm test` before code commits to ensure all platforms build correctly.
### Common Build Issues
- **Rust compilation errors**: Run `cargo clean` in `src-tauri/` directory
@@ -170,5 +305,4 @@ pnpm run cli:build
## Links
- [CLI Documentation](cli-usage.md)
- [CLI Testing Guide](cli-testing.md)
- [GitHub Discussions](https://github.com/tw93/Pake/discussions)

View File

@@ -1,5 +1,7 @@
# 高级用法
<h4 align="right"><strong><a href="advanced-usage.md">English</a></strong> | 简体中文</h4>
通过样式修改、JavaScript 注入和容器通信等方式自定义 Pake 应用。
## 样式自定义
@@ -12,12 +14,14 @@
2. 使用开发者工具找到要修改的元素
3. 编辑 `src-tauri/src/inject/style.js`
```javascript
const css = `
.ads-banner { display: none !important; }
.header { background: #1a1a1a !important; }
`;
```
```javascript
const css = `
.ads-banner { display: none !important; }
.header { background: #1a1a1a !important; }
`;
```
````
## JavaScript 注入
@@ -28,13 +32,13 @@ const css = `
1. 编辑 `src-tauri/src/inject/event.js`
2. 添加事件监听器:
```javascript
document.addEventListener("keydown", (e) => {
if (e.ctrlKey && e.key === "k") {
// 自定义操作
}
});
```
```javascript
document.addEventListener("keydown", (e) => {
if (e.ctrlKey && e.key === "k") {
// 自定义操作
}
});
```
## 容器通信
@@ -44,10 +48,10 @@ document.addEventListener("keydown", (e) => {
```javascript
window.__TAURI__.invoke("handle_scroll", {
scrollY: window.scrollY,
scrollX: window.scrollX,
scrollY: window.scrollY,
scrollX: window.scrollX,
});
```
````
**容器端Rust**
@@ -118,12 +122,49 @@ pake ./my-app/index.html --name my-static-app --use-local-file
### 前置条件
- Node.js ≥22.0.0 (推荐 LTS较旧版本 ≥16.0.0 可能可用)
- Node.js ≥22.0.0 (推荐 LTS较旧版本 ≥18.0.0 可能可用)
- Rust ≥1.89.0 (推荐稳定版,较旧版本 ≥1.78.0 可能可用)
- 平台特定构建工具:
- **macOS**: Xcode 命令行工具 (`xcode-select --install`)
- **Windows**: Visual Studio 构建工具与 MSVC
- **Linux**: `build-essential``libwebkit2gtk`、系统依赖
#### 平台特定要求
**macOS:**
- Xcode 命令行工具:`xcode-select --install`
**Windows:**
- **重要**:请先参阅 [Tauri 依赖项指南](https://tauri.app/start/prerequisites/)
- Windows 10 SDK (10.0.19041.0) 和 Visual Studio Build Tools 2022 (≥17.2)
- 必需的运行库:
1. Microsoft Visual C++ 2015-2022 Redistributable (x64)
2. Microsoft Visual C++ 2015-2022 Redistributable (x86)
3. Microsoft Visual C++ 2012 Redistributable (x86)(可选)
4. Microsoft Visual C++ 2013 Redistributable (x86)(可选)
5. Microsoft Visual C++ 2008 Redistributable (x86)(可选)
- **Windows ARM (ARM64) 支持**:在 Visual Studio Installer 中的"单个组件"下安装"MSVC v143 - VS 2022 C++ ARM64 构建工具"
**Linux (Ubuntu):**
```bash
sudo apt install libdbus-1-dev \
libsoup-3.0-dev \
libjavascriptcoregtk-4.1-dev \
libwebkit2gtk-4.1-dev \
build-essential \
curl \
wget \
file \
libxdo-dev \
libssl-dev \
libgtk-3-dev \
libayatana-appindicator3-dev \
librsvg2-dev \
gnome-video-effects \
gnome-video-effects-extra \
libglib2.0-dev \
pkg-config
```
### 安装
@@ -146,21 +187,117 @@ pnpm run dev
3. **注入逻辑**: 修改 `src-tauri/src/inject/` 中的文件以进行网页自定义
4. **测试**: 运行 `pnpm test` 进行综合验证
#### 命令参考
- **开发模式**`pnpm run dev`(热重载)
- **构建**`pnpm run build`
- **调试构建**`pnpm run build:debug`
- **CLI 构建**`pnpm run cli:build`
###
#### CLI 开发调
对于需要热重载的 CLI 开发,可修改 `bin/defaults.ts` 中的 `DEFAULT_DEV_PAKE_OPTIONS` 配置:
```typescript
export const DEFAULT_DEV_PAKE_OPTIONS: PakeCliOptions & { url: string } = {
...DEFAULT_PAKE_OPTIONS,
url: "https://weekly.tw93.fun/",
name: "Weekly",
};
```
然后运行:
```bash
# 运行所有测试(单元 + 集成 + 构建器)
pnpm test
pnpm run cli:dev
```
此脚本会读取上述配置并使用 watch 模式打包指定的应用,对 `pake-cli` 代码修改可实时热更新。
### 测试指南
统一的 CLI 构建测试套件,用于验证多平台打包功能。
#### 运行测试
```bash
# 完整测试套件(推荐)
pnpm test # 运行完整测试套件包含真实构建测试8-12分钟
# 开发时快速测试
pnpm test -- --no-build # 跳过构建测试仅验证核心功能30秒
# 构建 CLI 以供测试
pnpm run cli:build
```
#### 🚀 完整测试套件包含
- ✅ **单元测试**CLI命令、参数验证、响应时间
- ✅ **集成测试**:进程管理、文件权限、依赖解析
- ✅ **构建器测试**:平台检测、架构检测、文件命名
- ✅ **真实构建测试**完整的GitHub.com应用打包验证
#### 测试内容详情
**单元测试6个**
- 版本命令 (`--version`)
- 帮助命令 (`--help`)
- URL 验证(有效/无效链接)
- 参数验证(数字类型检查)
- CLI 响应时间(<2秒
- Weekly URL 可访问性
**集成测试3个**
- 进程生成和管理
- 文件系统权限检查
- 依赖包解析验证
**构建测试3个**
- 平台检测macOS/Windows/Linux
- 架构检测Intel/ARM64
- 文件命名模式验证
**真实构建测试(重点)**
_macOS_: 🔥 多架构构建(通用二进制)
- 编译 Intel + Apple Silicon 双架构
- 检测 `.app` 文件生成:`GitHubMultiArch.app`
- 备用检测:`src-tauri/target/universal-apple-darwin/release/bundle/macos/`
- 验证通用二进制:`file` 命令检查架构
_Windows_: 单架构构建
- 检测 EXE 文件:`src-tauri/target/x86_64-pc-windows-msvc/release/pake.exe`
- 检测 MSI 安装包:`src-tauri/target/x86_64-pc-windows-msvc/release/bundle/msi/*.msi`
_Linux_: 单架构构建
- 检测 DEB 包:`src-tauri/target/release/bundle/deb/*.deb`
- 检测 AppImage`src-tauri/target/release/bundle/appimage/*.AppImage`
#### 发布构建测试
```bash
# 实际构建测试(固定测试 weread + twitter 两个应用)
node ./tests/release.js
```
真实构建2个应用包验证完整的打包流程和 release.yml 逻辑是否正常工作。
#### 故障排除
- **CLI 文件不存在**:运行 `pnpm run cli:build`
- **测试超时**:构建测试需要较长时间完成
- **构建失败**:检查 Rust 工具链 `rustup update`
- **权限错误**:确保有写入权限
总计:**13 个测试**,全部通过表示 CLI 功能正常。提交代码前建议运行 `pnpm test` 确保所有平台构建正常。
### 常见构建问题
- **Rust 编译错误**: 在 `src-tauri/` 目录中运行 `cargo clean`
@@ -170,5 +307,4 @@ pnpm run cli:build
## 链接
- [CLI 文档](cli-usage_CN.md)
- [CLI 测试指南](cli-testing.md)
- [GitHub 讨论区](https://github.com/tw93/Pake/discussions)

View File

@@ -1,98 +0,0 @@
# Pake CLI 测试
统一的 CLI 构建测试套件,用于验证多平台打包功能。
## 运行测试
```bash
# 完整测试套件(推荐)
pnpm test # 运行完整测试套件包含真实构建测试8-12分钟
# 开发时快速测试
pnpm test -- --no-build # 跳过构建测试仅验证核心功能30秒
```
### 🚀 完整测试套件包含
-**单元测试**CLI命令、参数验证、响应时间
-**集成测试**:进程管理、文件权限、依赖解析
-**构建器测试**:平台检测、架构检测、文件命名
-**真实构建测试**完整的GitHub.com应用打包验证
## 测试内容
### 单元测试6个
- 版本命令 (`--version`)
- 帮助命令 (`--help`)
- URL 验证(有效/无效链接)
- 参数验证(数字类型检查)
- CLI 响应时间(<2秒
- Weekly URL 可访问性
### 集成测试3个
- 进程生成和管理
- 文件系统权限检查
- 依赖包解析验证
### 构建测试3个
- 平台检测macOS/Windows/Linux
- 架构检测Intel/ARM64
- 文件命名模式验证
### 真实构建测试(重点)
**macOS**: 🔥 多架构构建(通用二进制)
- 编译 Intel + Apple Silicon 双架构
- 检测 `.app` 文件生成:`GitHubMultiArch.app`
- 备用检测:`src-tauri/target/universal-apple-darwin/release/bundle/macos/`
- 验证通用二进制:`file` 命令检查架构
**Windows**: 单架构构建
- 检测 EXE 文件:`src-tauri/target/x86_64-pc-windows-msvc/release/pake.exe`
- 检测 MSI 安装包:`src-tauri/target/x86_64-pc-windows-msvc/release/bundle/msi/*.msi`
**Linux**: 单架构构建
- 检测 DEB 包:`src-tauri/target/release/bundle/deb/*.deb`
- 检测 AppImage`src-tauri/target/release/bundle/appimage/*.AppImage`
## 为什么重点测试多架构?
多架构构建是最复杂、最容易出错的环节:
- 需要同时编译两个架构x86_64 + aarch64
- 生成通用二进制文件技术复杂
- 架构兼容性问题频发
- Apple Silicon 迁移期关键功能
## 测试结果
总计:**13 个测试**,全部通过表示 CLI 功能正常。
## 故障排除
**CLI 文件不存在**:运行 `pnpm run cli:build`
**测试超时**:构建测试需要较长时间完成
**构建失败**:检查 Rust 工具链 `rustup update`
**权限错误**:确保有写入权限
## 发布构建测试
```bash
# 实际构建测试(固定测试 weread + twitter 两个应用)
node ./tests/release.js
```
真实构建2个应用包验证完整的打包流程和 release.yml 逻辑是否正常工作。
## 开发建议
提交代码前建议运行 `pnpm test` 确保所有平台构建正常。

View File

@@ -1,5 +1,9 @@
# CLI Usage Guide
<h4 align="right"><strong>English</strong> | <a href="cli-usage_CN.md">简体中文</a></h4>
Complete command-line reference and basic usage for Pake CLI.
## Installation
Ensure that your Node.js version is 22.0 or higher (e.g., 22.11.0). _Note: Older versions ≥18.0.0 may also work._
@@ -28,42 +32,11 @@ echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.bashrc
source ~/.bashrc
```
<details>
<summary><strong>Considerations for Windows & Linux Users</strong></summary>
**Prerequisites:**
- **CRITICAL**: Consult [Tauri prerequisites](https://tauri.app/start/prerequisites/) before proceeding.
- For Windows users (ensure that `Win10 SDK (10.0.19041.0)` and `Visual Studio build tool 2022 (>=17.2)` are installed), additional installations are required:
1. Microsoft Visual C++ 2015-2022 Redistributable (x64)
2. Microsoft Visual C++ 2015-2022 Redistributable (x86)
3. Microsoft Visual C++ 2012 Redistributable (x86) (optional)
4. Microsoft Visual C++ 2013 Redistributable (x86) (optional)
5. Microsoft Visual C++ 2008 Redistributable (x86) (optional)
**For Windows on ARM (ARM64) support**: Install the C++ ARM64 build tools in Visual Studio Installer under "Individual Components" → "MSVC v143 - VS 2022 C++ ARM64 build tools". The system will automatically detect ARM64 architecture and build native ARM64 binaries.
- For Ubuntu users, execute the following commands to install the required libraries before compiling:
```bash
sudo apt install libdbus-1-dev \
libsoup-3.0-dev \
libjavascriptcoregtk-4.1-dev \
libwebkit2gtk-4.1-dev \
build-essential \
curl \
wget \
file \
libxdo-dev \
libssl-dev \
libgtk-3-dev \
libayatana-appindicator3-dev \
librsvg2-dev \
gnome-video-effects \
gnome-video-effects-extra \
libglib2.0-dev \
pkg-config
```
</details>
- Node.js ≥18.0.0
- Rust ≥1.78.0 (installed automatically if missing)
- **Windows/Linux**: See [system dependencies guide](advanced-usage.md#prerequisites) for platform-specific requirements
## Quick Start
@@ -305,7 +278,7 @@ Hide window instead of closing the application when clicking close button. Platf
#### [title]
Set the window title bar text. If not specified, the window title will be empty.
Set the window title bar text. macOS shows no title if not specified; Windows/Linux fallback to app name.
```shell
--title <string>
@@ -417,26 +390,6 @@ Enable developer tools and detailed logging for debugging.
After completing the above steps, your application should be successfully packaged. Please note that the packaging process may take some time depending on your system configuration and network conditions. Be patient, and once the packaging is complete, you can find the application installer in the specified directory.
## Development
The `DEFAULT_DEV_PAKE_OPTIONS` configuration in `bin/defaults.ts` can be modified at development time to match the `pake-cli` configuration description.
```typescript
export const DEFAULT_DEV_PAKE_OPTIONS: PakeCliOptions & { url: string } = {
...DEFAULT_PAKE_OPTIONS,
url: "https://weekly.tw93.fun/",
name: "Weekly",
};
```
then
```bash
pnpm run cli:dev
```
The script will read the above configuration and packages the specified `app` using `watch` mode, and changes to the `pake-cli` code and `pake` are hot updated in real time.
## Docker
```shell

View File

@@ -1,5 +1,9 @@
# CLI 使用指南
<h4 align="right"><strong><a href="cli-usage.md">English</a></strong> | 简体中文</h4>
完整的命令行参数说明和基础用法指南。
## 安装
请确保您的 Node.js 版本为 22 或更高版本(例如 22.11.0。_注意较旧的版本 ≥18.0.0 也可能可以工作。_
@@ -28,42 +32,11 @@ echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.bashrc
source ~/.bashrc
```
<details>
<summary><strong>Windows/Linux 注意事项</strong></summary>
**前置条件:**
- **非常重要**:请参阅 Tauri 的 [依赖项指南](https://tauri.app/start/prerequisites/)。
- 对于 Windows 用户,请确保至少安装了 `Win10 SDK(10.0.19041.0)``Visual Studio Build Tools 2022版本 17.2 或更高)`,此外还需要安装以下组件:
1. Microsoft Visual C++ 2015-2022 Redistributable (x64)
2. Microsoft Visual C++ 2015-2022 Redistributable (x86)
3. Microsoft Visual C++ 2012 Redistributable (x86)(可选)
4. Microsoft Visual C++ 2013 Redistributable (x86)(可选)
5. Microsoft Visual C++ 2008 Redistributable (x86)(可选)
**Windows ARMARM64支持**:在 Visual Studio Installer 中的"单个组件"下安装"MSVC v143 - VS 2022 C++ ARM64 构建工具"。系统会自动检测 ARM64 架构并构建原生 ARM64 二进制文件。
- 对于 Ubuntu 用户,在开始之前,建议运行以下命令以安装所需的依赖项:
```bash
sudo apt install libdbus-1-dev \
libsoup-3.0-dev \
libjavascriptcoregtk-4.1-dev \
libwebkit2gtk-4.1-dev \
build-essential \
curl \
wget \
file \
libxdo-dev \
libssl-dev \
libgtk-3-dev \
libayatana-appindicator3-dev \
librsvg2-dev \
gnome-video-effects \
gnome-video-effects-extra \
libglib2.0-dev \
pkg-config
```
</details>
- Node.js ≥18.0.0
- Rust ≥1.78.0(如缺失将自动安装)
- **Windows/Linux**:详细系统依赖请参考 [高级用法指南](advanced-usage_CN.md#前置条件)
## 快速开始
@@ -349,7 +322,7 @@ pake https://github.com --name GitHub --keep-binary
#### [title]
设置窗口标题栏文本。如果未指定,窗口标题将为空
设置窗口标题栏文本macOS 未指定时不显示标题Windows/Linux 回退使用应用名称
```shell
--title <string>
@@ -416,26 +389,6 @@ pake ./my-app/index.html --name "my-app" --use-local-file
完成上述步骤后,您的应用程序应该已经成功打包。请注意,根据您的系统配置和网络状况,打包过程可能需要一些时间。请耐心等待,一旦打包完成,您就可以在指定的目录中找到应用程序安装包。
## 开发调试
开发时可以修改 `bin/defaults.ts` 中 `DEFAULT_DEV_PAKE_OPTIONS` 配置,配置项和 `pake-cli` 配置说明保持一致
```typescript
export const DEFAULT_DEV_PAKE_OPTIONS: PakeCliOptions & { url: string } = {
...DEFAULT_PAKE_OPTIONS,
url: "https://weekly.tw93.fun/",
name: "Weekly",
};
```
之后运行
```bash
pnpm run cli:dev
```
脚本会读取上述配置并使用 `watch` 模式打包指定的 `app`,对 `pake-cli` 代码和 `pake` 的修改都会实时热更新。
## Docker 使用
```shell

View File

@@ -1,5 +1,7 @@
# GitHub Actions Usage Guide
<h4 align="right"><strong>English</strong> | <a href="github-actions-usage_CN.md">简体中文</a></h4>
Build Pake apps online without installing development tools locally.
## Quick Steps
@@ -15,7 +17,7 @@ Build Pake apps online without installing development tools locally.
3. Fill in the form (same parameters as [CLI options](cli-usage.md))
4. Click `Run Workflow`
![Actions Interface](https://raw.githubusercontent.com/tw93/static/main/pake/action.png)
![Actions Interface](https://raw.githubusercontent.com/tw93/static/main/pake/action.png)
### 3. Download App

View File

@@ -1,5 +1,7 @@
# GitHub Actions 使用指南
<h4 align="right"><strong><a href="github-actions-usage.md">English</a></strong> | 简体中文</h4>
无需本地安装开发工具,在线构建 Pake 应用。
## 快速步骤
@@ -15,7 +17,7 @@
3. 填写表单(参数与 [CLI 选项](cli-usage_CN.md) 相同)
4. 点击 `Run Workflow`
![Actions 界面](https://raw.githubusercontent.com/tw93/static/main/pake/action.png)
![Actions 界面](https://raw.githubusercontent.com/tw93/static/main/pake/action.png)
### 3. 下载应用