Skip to content

Commit

Permalink
docs: update
Browse files Browse the repository at this point in the history
  • Loading branch information
yzqzy committed May 23, 2024
1 parent c79af87 commit 0cd2501
Show file tree
Hide file tree
Showing 6 changed files with 114 additions and 8 deletions.
84 changes: 84 additions & 0 deletions .github/workflows/build_wxhelper-3.9.8.25.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
name: Build wxhelper-3.9.8.25

on:
push:
tags:
- 'v*'

paths-ignore:
- '**.md'
- '**.spec.js'
- '.idea'
- '.vscode'
- '.dockerignore'
- 'Dockerfile'
- '.gitignore'
- '.github/**'
- '!.github/workflows/build.yml'

jobs:
build:
runs-on: ${{ matrix.os }}

strategy:
matrix:
# os: [macos-latest, ubuntu-latest, windows-latest]
os: [windows-latest]

steps:
- name: Checkout Code
uses: actions/checkout@v3

- name: Setup Node.js
uses: actions/setup-node@v3
with:
node-version: 16

- name: Install Dependencies
run: npm install

- name: Build Release Files
run: npm run build
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Cleanup Artifacts for MacOS
if: matrix.os == 'macos-latest'
run: |
npx rimraf --glob "release/!(*.dmg)"
- name: Cleanup Artifacts for Ubuntu
if: matrix.os == 'ubuntu-latest'
run: |
npx rimraf --glob "release/!(*.AppImage)"
- name: Cleanup Artifacts for Windows
if: matrix.os == 'windows-latest'
run: |
npx rimraf --glob "release/!(*.exe)"
- name: Upload Artifact
uses: actions/upload-artifact@v3
with:
name: release_on_${{ matrix.os }}
path: release
retention-days: 5

- name: Extract Version
id: extract_version
run: |
echo "::set-output name=version::$(echo ${{ github.ref }} | sed 's/refs\/tags\///')"
- name: Create Release and Upload Release Asset
uses: softprops/action-gh-release@v1
if: startsWith(github.ref, 'refs/tags/')
with:
tag_name: ${{ steps.extract_version.outputs.version }}
name: wxhelper-3.9.8.25
files: 'release/**'
body: ''
# prerelease: true
# generate_release_notes: true
# fail_on_unmatched_files: true
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
9 changes: 5 additions & 4 deletions docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ export default defineConfig({
logo: '/logo.png',

nav: [
{ text: '指引', link: '/guide' },
{ text: '指南', link: '/guide' },
{
text: '相关链接',
items: [
Expand All @@ -34,12 +34,13 @@ export default defineConfig({

sidebar: [
{
text: '指引',
text: '指南',
items: [
{ text: '微信助手', link: '/guide' },
{ text: '快速开始', link: '/getting-started' },
{ text: '功能', link: '/features' },
{ text: '聊天记录迁移', link: '/chat-history-migration' }
{ text: '功能介绍', link: '/features' },
{ text: '聊天记录迁移', link: '/chat-history-migration' },
{ text: '常见问题', link: '/faq' }
]
},
{
Expand Down
7 changes: 7 additions & 0 deletions docs/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# 常见问题

1. [npm i 报错](https://github.com/yzqzy/wechat-assistant/issues/8)
2. [注入微信3.9.5.81后崩溃](https://github.com/yzqzy/wechat-assistant/issues/9)
3. [注入闪退问题](https://github.com/yzqzy/wechat-assistant/issues/4)
4. [使用不兼容版本](https://github.com/yzqzy/wechat-assistant/issues/7)
5. [微信提示版本低](https://github.com/yzqzy/wechat-assistant/issues/22)
2 changes: 1 addition & 1 deletion docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

> 如果你不会使用命令行工具,可以跳过 3 步骤,直接运行微信助手客户端。
1.[release](https://github.com/yzqzy/wechat-assistant/releases/tag/v0.0.0) 中下载相关文件
1.[WeChat Assets](https://github.com/yzqzy/wechat-assistant/releases/tag/v0.0.0) 中下载相关文件
2. 安装 WeChatSetup 3.9.5.81 版本并且登录
3. 使用 Injector 工具进行注入,如果成功的话你将会看到: `Successfully injected module!`

Expand Down
15 changes: 13 additions & 2 deletions docs/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,17 @@

PC 微信助手,基于 Electron、WeChat Hook 实现。

* 仅支持 windows 3.9.5.81 版本。

* 仅支持 Windows 系统。
* 本仓库发布内容仅供学习研究,请勿用于非法或商业用途! 如因此引起任何法律纠纷,与作者无关! 没有后门或木马,也不会获取或存储任何信息。 请按照国家法律法规及腾讯的相关原则学习研究! 我们不对用户的任何下载或任何行为负责。 请下载后24小时内删除!

## 1. 支持版本

1. wxhelper-3.9.5.81 版本。

> 3.9.5.81 存在微信提示版本低,需升级微信问题,需要自主解决该问题,[issue](https://github.com/yzqzy/wechat-assistant/issues/22)
2. wxhelper-3.9.8.25 版本(开发中)。

## 2. 交流群

[telegram](https://t.me/wxassistant)
5 changes: 4 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,13 @@ hero:
alt: VitePress
actions:
- theme: brand
text: 使用指南
link: /guide
- theme: alt
text: 功能介绍
link: /features
- theme: alt
text: 如何使用
text: 快速开始
link: /getting-started

features:
Expand Down

0 comments on commit 0cd2501

Please sign in to comment.