Skip to content

Commit e29c00b

Browse files
committed
Update documentation to reflect the rebranding
1 parent 53b3101 commit e29c00b

37 files changed

+257
-243
lines changed

docs/exchange/github.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
# github
1+
# github
22

3-
https://github.com/Sjj1024/PackPlus/discussions
3+
https://github.com/Sjj1024/PakePlus/discussions

docs/exchange/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,16 @@ If you have WeChat, you can join our group chat or add me directly. Please note:
66
2. **Collective problem-solving** - Discussions help compile common issues and solutions for everyone's benefit.
77
3. **Direct assistance** - If no solution exists, @mention me and I'll respond when available.
88
4. **Group access** - If the QR code expires or the group is full, add my WeChat for an invitation.
9-
5. **Private consultation** - For 1-on-1 support, please sponsor PackPlus first.
9+
5. **Private consultation** - For 1-on-1 support, please sponsor PakePlus first.
1010
6. **Alternative contact** - Submit GitHub issues if WeChat isn't convenient.
1111
7. **Efficiency notice** - Please follow these protocols as I have limited availability.
1212
8. **Group rules**:
13-
- Technical discussions only
14-
- No ads/spam/off-topic content
15-
- Prohibited: political, religious, violent, pornographic, or terrorist content
13+
- Technical discussions only
14+
- No ads/spam/off-topic content
15+
- Prohibited: political, religious, violent, pornographic, or terrorist content
1616

1717
<Qun />
1818

1919
<script setup>
2020
import Qun from '../components/qun.vue'
21-
</script>
21+
</script>

docs/guide/build.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Compilation and Release
22

3-
This step instructs GitHub to compile your project into a cross-platform desktop application. Currently, PackPlus only supports desktop platforms (mobile support coming soon). You can choose between two release modes:
3+
This step instructs GitHub to compile your project into a cross-platform desktop application. Currently, PakePlus only supports desktop platforms (mobile support coming soon). You can choose between two release modes:
44

55
1. **Release Mode (Debug Disabled)** - For production use
66
2. **Debug Mode** - Enables error logging in console when the app launches
@@ -19,14 +19,16 @@ If failed: An error notification will appear in the upper right corner - either
1919
![](../static/imgs/building1.webp)
2020

2121
## Successful Release:
22+
2223
Congratulations 🎉🎉🎉! Your application has been successfully compiled. Click "Download" to get your software, or click the name to copy the download link for browser access.
2324
![](../static/imgs/publish2.webp)
2425

2526
## Important Notes:
27+
2628
1. **Release Modes**: Debug mode enables error logging visible in console (right-click → Inspect to view)
2729
2. **Release Notes**: Optional description of changes (can be skipped)
2830
3. **Failed Releases**: A red warning icon appears top-right with error details for troubleshooting
2931
4. **GitHub Build Failures**: Redirects to GitHub's build page with specific error messages
3032
5. **Persistent Issues**: Contact us via WeChat: lanxingme or join our support group for assistance
3133

32-
(Note: All image paths have been updated from ../static to ../static as requested)
34+
(Note: All image paths have been updated from ../static to ../static as requested)

docs/guide/config.md

Lines changed: 46 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,56 @@
1-
# Basic Configuration
1+
# Basic Configuration
22

3-
After creating your project, you'll need to configure some basic settings. These include your app name, the URL to package, the app identifier (ID), and the version number. The first four fields are required, while the rest can be configured based on your needs.
3+
After creating your project, you'll need to configure some basic settings. These include your app name, the URL to package, the app identifier (ID), and the version number. The first four fields are required, while the rest can be configured based on your needs.
44

5-
- **App Name**: Supports Chinese, English, etc., but no spaces.
6-
- **Website URL**: Can be a local or web address, but must start with `http://` or `https://`. Alternatively, you can use a local HTML file or a `dist` folder from a Vue/React build.
7-
- **App ID**: A unique identifier for your software (cannot be duplicated across projects).
8-
- **Version Number**: Used to distinguish different versions of your app.
5+
- **App Name**: Supports Chinese, English, etc., but no spaces.
6+
- **Website URL**: Can be a local or web address, but must start with `http://` or `https://`. Alternatively, you can use a local HTML file or a `dist` folder from a Vue/React build.
7+
- **App ID**: A unique identifier for your software (cannot be duplicated across projects).
8+
- **Version Number**: Used to distinguish different versions of your app.
99

10-
![](../static/imgs/config1.webp)
10+
![](../static/imgs/config1.webp)
1111

12-
After basic configuration, click the **Preview** button to see how your app will look. If everything is correct, click **Publish** to start packaging.
12+
After basic configuration, click the **Preview** button to see how your app will look. If everything is correct, click **Publish** to start packaging.
1313

1414
---
1515

16-
### **Important Notes:**
17-
18-
1. **App Name**: Supports Chinese, English, etc., but **no spaces**.
19-
2. **Website URL**:
20-
- Can be a local or web address (must start with `http://` or `https://`).
21-
- Can also be a local HTML file or a `dist` folder from Vue/React builds.
22-
- **Single file size should not exceed 10MB** (due to GitHub restrictions). For large files (e.g., videos/images), use external links or compress them below 10MB.
23-
3. **App ID**: Must be **unique** (no duplicates).
24-
4. **Version Number**: Used to track app updates.
25-
5. **App Icon**:
26-
- Supports local image uploads.
27-
- macOS rounded corners option available.
28-
- Defaults to PackPlus icon if not set.
29-
6. **Window Persistence**: Restores window size/position on relaunch.
30-
7. **Single Instance Mode**: Prevents multiple app instances.
31-
8. **Debug Mode**: Enables debugging in the preview window.
32-
9. **Tauri API**: Allows calling Tauri APIs from JavaScript.
33-
10. **Script File**:
34-
- Supports custom JS injection (executes on app launch).
35-
- **Warning**: Advanced feature (do not modify if unfamiliar with coding).
36-
11. **Window Mode**:
37-
- Supports Desktop/iPhone/iPad/Android/Custom layouts.
38-
12. **Element Filtering**: Hides unwanted elements (e.g., ads) via CSS selectors.
39-
13. **App Description**: Briefly explain your app’s purpose.
40-
14. **Advanced Settings (Top-Right)**:
41-
- Custom window configurations (refer to Tauri2 docs).
42-
- **Warning**: Advanced feature (do not modify if unsure).
43-
15. **JSON Configuration**:
44-
- Supports JSON-based customization (refer to Tauri2 docs).
45-
- **Warning**: Advanced feature (do not modify if unsure).
46-
16. **Inject jQuery**:
47-
- Adds jQuery support for DOM manipulation in scripts.
48-
- **Warning**: Use with caution if unfamiliar with jQuery.
16+
### **Important Notes:**
17+
18+
1. **App Name**: Supports Chinese, English, etc., but **no spaces**.
19+
2. **Website URL**:
20+
- Can be a local or web address (must start with `http://` or `https://`).
21+
- Can also be a local HTML file or a `dist` folder from Vue/React builds.
22+
- **Single file size should not exceed 10MB** (due to GitHub restrictions). For large files (e.g., videos/images), use external links or compress them below 10MB.
23+
3. **App ID**: Must be **unique** (no duplicates).
24+
4. **Version Number**: Used to track app updates.
25+
5. **App Icon**:
26+
- Supports local image uploads.
27+
- macOS rounded corners option available.
28+
- Defaults to PakePlus icon if not set.
29+
6. **Window Persistence**: Restores window size/position on relaunch.
30+
7. **Single Instance Mode**: Prevents multiple app instances.
31+
8. **Debug Mode**: Enables debugging in the preview window.
32+
9. **Tauri API**: Allows calling Tauri APIs from JavaScript.
33+
10. **Script File**:
34+
- Supports custom JS injection (executes on app launch).
35+
- **Warning**: Advanced feature (do not modify if unfamiliar with coding).
36+
11. **Window Mode**:
37+
- Supports Desktop/iPhone/iPad/Android/Custom layouts.
38+
12. **Element Filtering**: Hides unwanted elements (e.g., ads) via CSS selectors.
39+
13. **App Description**: Briefly explain your app’s purpose.
40+
14. **Advanced Settings (Top-Right)**:
41+
- Custom window configurations (refer to Tauri2 docs).
42+
- **Warning**: Advanced feature (do not modify if unsure).
43+
15. **JSON Configuration**:
44+
- Supports JSON-based customization (refer to Tauri2 docs).
45+
- **Warning**: Advanced feature (do not modify if unsure).
46+
16. **Inject jQuery**:
47+
- Adds jQuery support for DOM manipulation in scripts.
48+
- **Warning**: Use with caution if unfamiliar with jQuery.
4949

5050
---
5151

52-
### **Next Steps**
53-
- Click **Preview** to verify your app’s appearance.
54-
- Click **Publish** to start the packaging process.
55-
- For advanced settings, refer to the [Tauri2 documentation](#) (recommended for experienced users only).
52+
### **Next Steps**
53+
54+
- Click **Preview** to verify your app’s appearance.
55+
- Click **Publish** to start the packaging process.
56+
- For advanced settings, refer to the [Tauri2 documentation](#) (recommended for experienced users only).

docs/guide/creat.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,14 @@ After obtaining and verifying your GitHub Token, you're ready to create a projec
44

55
## Steps to Create a Project
66

7-
1. On the PackPlus homepage, click the `+` button to create a new project.
7+
1. On the PakePlus homepage, click the `+` button to create a new project.
88
2. In the project creation popup, enter your project name and click the `Confirm` button to create the project.
99
3. After clicking `Confirm`, wait for the project creation to complete. You'll be automatically redirected to the project configuration page.
1010

1111
![](../static/imgs/creat1.webp)
1212

1313
## Important Notes:
14+
1415
1. Project names cannot start with numbers.
1516
2. Project names must be unique and cannot duplicate existing project names.
16-
3. Project names can only contain letters, numbers, underscores, and hyphens. Spaces, Chinese characters, and special characters are not allowed.
17+
3. Project names can only contain letters, numbers, underscores, and hyphens. Spaces, Chinese characters, and special characters are not allowed.

docs/guide/custompack.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@
88
<Badge type="tip" text="More Custom Build Options" />
99
:::
1010

11-
If you are a developer and want to debug your frontend project, or if your `dist` directory is particularly large with many files, but PackPlus restricts file size and quantity due to GitHub API limitations, you can use advanced methods to sync your `dist` directory to a GitHub repository and achieve compilation and release.
11+
If you are a developer and want to debug your frontend project, or if your `dist` directory is particularly large with many files, but PakePlus restricts file size and quantity due to GitHub API limitations, you can use advanced methods to sync your `dist` directory to a GitHub repository and achieve compilation and release.
1212

1313
## Steps
1414

15-
1. First, create a project on PackPlus, for example, a project named: `deepseek`.
15+
1. First, create a project on PakePlus, for example, a project named: `deepseek`.
1616

17-
2. Then, clone your PackPlus repository to your local machine.
18-
After each user fills in and verifies their token on PackPlus, the PackPlus/PackPlus-Android/PackPlus-iOS repository is automatically forked to their GitHub account. You can find your PackPlus repository under your GitHub account and clone it locally.
19-
Note: If you want to build for desktop, clone `PackPlus`; if you want to build for mobile, clone `PackPlus-Android` or `PackPlus-iOS`.
17+
2. Then, clone your PakePlus repository to your local machine.
18+
After each user fills in and verifies their token on PakePlus, the PakePlus/PakePlus-Android/PakePlus-iOS repository is automatically forked to their GitHub account. You can find your PakePlus repository under your GitHub account and clone it locally.
19+
Note: If you want to build for desktop, clone `PakePlus`; if you want to build for mobile, clone `PakePlus-Android` or `PakePlus-iOS`.
2020

2121
3. Use Git commands to pull all branches of your repository. There will definitely be a branch named: `deepseek`.
2222
After switching to the `deepseek` branch, copy the contents of your `dist` folder into the `src` directory, then commit and push the changes to your repository.
@@ -48,4 +48,4 @@ If you are a developer and want to debug your frontend project, or if your `dist
4848
4. After making the changes, push this branch to your repository, then trigger the compilation in GitHub Actions.
4949
When triggering, remember to select the branch as `deepseek`, then click "Run workflow" and wait for the compilation to complete.
5050

51-
5. After the release is complete, go to the PackPlus release page to download your software.
51+
5. After the release is complete, go to the PakePlus release page to download your software.

docs/guide/index.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@
22
layout: doc
33
---
44

5-
# PackPlus Guide
5+
# PakePlus Guide
66

7-
PackPlus is a packaging tool based on Tauri2 and GitHub. You can also call me PP or 2P🫣. you can package any website/Vue/React project's static `dist` files into a cross-platform desktop application. It’s compact (less than 5M) and high-performance, while PackPlus itself is only about 8M. <span style="color:red">in order to avoid excessive pressure on Github servers caused by excessive use, PackPlus has implemented restrictions: only one project can be created and published one hourly!</span>
7+
PakePlus is a packaging tool based on Tauri2 and GitHub. You can also call me PP or 2P🫣. you can package any website/Vue/React project's static `dist` files into a cross-platform desktop application. It’s compact (less than 5M) and high-performance, while PakePlus itself is only about 8M. <span style="color:red">in order to avoid excessive pressure on Github servers caused by excessive use, PakePlus has implemented restrictions: only one project can be created and published one hourly!</span>
88

99
<video src="../static/videos/pakeplus.mp4" controls="controls" width="100%"></video>
1010

1111
## Features
1212

1313
- 🎐 **20x smaller** than Electron packages (less than 5M!) and **10x faster** in performance
14-
- 🚀 Built on **Rust Tauri**, making PackPlus **lighter and faster** than JS-based frameworks
14+
- 🚀 Built on **Rust Tauri**, making PakePlus **lighter and faster** than JS-based frameworks
1515
- 📦 **Rich built-in features**—supports shortcuts, immersive windows, and minimalist customization
16-
- 👻 PackPlus is just an **ultra-lightweight** tool that replaces old packaging methods with Tauri, supporting **cross-platform desktop**
16+
- 👻 PakePlus is just an **ultra-lightweight** tool that replaces old packaging methods with Tauri, supporting **cross-platform desktop**
1717
- 📲 Uses **native frameworks** to package Android and iOS apps, resulting in **smaller and faster** builds than Tauri2
1818
- 🤗 **Simple UI**—no need to install any local dev environment, saving time, effort, and disk space
1919
- 🌹 No complex dependencies required—**automatically packages in the cloud** using GitHub Actions
@@ -36,19 +36,19 @@ PackPlus is a packaging tool based on Tauri2 and GitHub. You can also call me PP
3636
- **Company intranet tools**—restrict access to only your client, keeping the URL private.
3737
- Turn a website into your own app and **add custom features**, like injecting JS for automation.
3838
- Too many **annoying ads**? Block them with custom JS.
39-
- Want to use **Tauri2 for packaging**, but your local environment is too bloated? **PackPlus saves disk space!**
39+
- Want to use **Tauri2 for packaging**, but your local environment is too bloated? **PakePlus saves disk space!**
4040

4141
## Popular
4242

4343
<img src="../static/imgs/preview.webp" width=1920/>
4444

45-
PackPlus supports installation packages for both ARM and Intel architectures. Popular program installation packages typically only include the ARM version (M-series chips) for Mac, the Intel (x64) version for Windows, and the x64 version for Linux. If you need installation packages for additional architectures, you can use PackPlus to compile custom packages tailored to your specific needs.
45+
PakePlus supports installation packages for both ARM and Intel architectures. Popular program installation packages typically only include the ARM version (M-series chips) for Mac, the Intel (x64) version for Windows, and the x64 version for Linux. If you need installation packages for additional architectures, you can use PakePlus to compile custom packages tailored to your specific needs.
4646

4747
<Popular />
4848

4949
## Star History
5050

51-
[![Star History Chart](https://api.star-history.com/svg?repos=Sjj1024/PackPlus,Sjj1024/PackPlus-iOS,Sjj1024/PackPlus-Android&type=Date)](https://www.star-history.com/#Sjj1024/PackPlus&Sjj1024/PackPlus-iOS&Sjj1024/PackPlus-Android&Date)
51+
[![Star History Chart](https://api.star-history.com/svg?repos=Sjj1024/PakePlus,Sjj1024/PakePlus-iOS,Sjj1024/PakePlus-Android&type=Date)](https://www.star-history.com/#Sjj1024/PakePlus&Sjj1024/PakePlus-iOS&Sjj1024/PakePlus-Android&Date)
5252

5353
<script setup>
5454
import Popular from '../components/popular.vue'

0 commit comments

Comments
 (0)