Skip to content

Commit 28bcbf0

Browse files
📝 docs: Update PWA & update pnpm in CONTRIBUTING (lobehub#2148)
* 📝 docs: Update PWA & update `pnpm` in CONTRIBUTING * 📝 docs: Update image & callout
1 parent 2655918 commit 28bcbf0

File tree

3 files changed

+75
-3
lines changed

3 files changed

+75
-3
lines changed

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Choose a meaningful branch name related to your work. It makes collaboration eas
4343
🧙‍♀️ Time to work your magic! Write your code, fix bugs, or add new features. Be sure to follow our project's coding style. You can check if your code adheres to our style using:
4444

4545
```bash
46-
yarn lint
46+
pnpm lint
4747
```
4848

4949
This adds a bit of enchantment to your coding experience! ✨

docs/usage/features/pwa.mdx

+37-1
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,15 @@ We understand the importance of providing a seamless experience for users in tod
2525

2626
If you are unfamiliar with the installation process of PWA, you can follow the steps below to add LobeChat as a desktop app (also applicable to mobile devices):
2727

28+
## Running on Chrome / Edge
29+
30+
<Callout type={'important'}>
31+
On macOS, when using a Chrome-installed PWA, it is required that Chrome be open, otherwise Chrome will automatically open and then launch the PWA app.
32+
</Callout>
33+
2834
<Steps>
29-
### Run Chrome or Edge browser on your computer
35+
36+
### Run Chrome or Edge browser on your computer
3037

3138
### Visit the LobeChat webpage
3239

@@ -35,3 +42,32 @@ If you are unfamiliar with the installation process of PWA, you can follow the s
3542
### Follow the on-screen instructions to complete the PWA installation
3643

3744
</Steps>
45+
46+
## Running on Safari
47+
48+
Safari PWA requires macOS Ventura or later. The PWA installed by Safari does not require Safari to be open; you can directly open the PWA app.
49+
50+
<Steps>
51+
52+
### Run Safari browser on your computer
53+
54+
### Visit the LobeChat webpage
55+
56+
### In the top right corner of the address bar, click the <kbd>Share</kbd> icon
57+
58+
### Click <kbd>Add to Dock</kbd>
59+
60+
### Follow the on-screen instructions to complete the PWA installation
61+
62+
</Steps>
63+
64+
<Callout type={'tip'}>
65+
The default installed LobeChat PWA icon has a black background, you can use <kbd>cmd</kbd> + <kbd>i</kbd> to paste the following image to replace it with a white background.
66+
</Callout>
67+
68+
<Image
69+
alt={'PWA White Icon'}
70+
borderless
71+
cover
72+
src={'https://github.com/lobehub/lobe-chat/assets/36695271/16ce82cb-49be-4d4d-ac86-4403a1536917'}
73+
/>

docs/usage/features/pwa.zh-CN.mdx

+37-1
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,15 @@ tags:
2525

2626
若您未熟悉 PWA 的安装过程,您可以按照以下步骤将 LobeChat 添加为您的桌面应用(也适用于移动设备):
2727

28+
## Chrome / Edge 浏览器上运行
29+
30+
<Callout type={'important'}>
31+
macOS 下,使用 Chrome 安装的 PWA 时,必须要求 Chrome 是打开状态,否则会自动打开 Chrome 再打开 PWA 应用。
32+
</Callout>
33+
2834
<Steps>
29-
### 在电脑上运行 Chrome 或 Edge 浏览器
35+
36+
### 在电脑上运行 Chrome 或 Edge 浏览器
3037

3138
### 访问 LobeChat 网页
3239

@@ -35,3 +42,32 @@ tags:
3542
### 根据屏幕上的指示完成 PWA 的安装
3643

3744
</Steps>
45+
46+
## Safari 浏览器上运行
47+
48+
Safari PWA 需要 macOS Ventura 或更高版本。Safari 安装的 PWA 并不要求 Safari 是打开状态,可以直接打开 PWA 应用。
49+
50+
<Steps>
51+
52+
### 在电脑上运行 Safari 浏览器
53+
54+
### 访问 LobeChat 网页
55+
56+
### 在地址栏的右上角,单击 <kbd>分享</kbd> 图标
57+
58+
### 点选 <kbd>添加到程序坞</kbd>
59+
60+
### 根据屏幕上的指示完成 PWA 的安装
61+
62+
</Steps>
63+
64+
<Callout type={'tip'}>
65+
默认安装的 LobeChat PWA 图标是黑色背景的,您可以在自行使用 <kbd>cmd</kbd> + <kbd>i</kbd> 粘贴如下图片替换为白色背景的。
66+
</Callout>
67+
68+
<Image
69+
alt={'PWA White Icon'}
70+
borderless
71+
cover
72+
src={'https://github.com/lobehub/lobe-chat/assets/36695271/16ce82cb-49be-4d4d-ac86-4403a1536917'}
73+
/>

0 commit comments

Comments
 (0)