Skip to content

Commit e983e4b

Browse files
LucienShuiLucienShui
committed
chore(docs): Add home image, update doc links, sync submodules
1 parent c45754b commit e983e4b

File tree

5 files changed

+11
-157
lines changed

5 files changed

+11
-157
lines changed

‎README.md‎

Lines changed: 4 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77

88
English | [简体中文](./README_zh.md)
99

10+
<img width="923" height="620" alt="Image" src="https://github.com/user-attachments/assets/35dad1b4-5652-4f2f-8eac-38c49da0545f" />
11+
1012
## Docs
1113

1214
[OmniBox Docs](https://www.omnibox.pro/docs/?utm_source=gh_readme_en)
@@ -26,91 +28,17 @@ OmniBox (小黑) is a simple, cross-platform, all-in-one AI knowledge hub. All y
2628
7. **WeChat Bot**: Save files, webpages, videos, voice messages, text, and chat records to OmniBox anytime, anywhere via WeChat.
2729
8. User and team system, permissions, sharing management, multi-tenancy, multi-language, dark mode, mobile responsiveness, and more.
2830

29-
### Screenshots
30-
31-
<details>
32-
<table>
33-
<tr>
34-
<th>Feature</th>
35-
<th>Source</th>
36-
<th>Parsing Result</th>
37-
</tr>
38-
<tr>
39-
<td>Save Webpage to OmniBox</td>
40-
<td><img src="assets/screenshots/extension/SCR-20250727-uniy.png" alt="Source web"></td>
41-
<td><img src="assets/screenshots/extension/SCR-20250727-srzd.png" alt="Extension parsing result"></td>
42-
</tr>
43-
<tr>
44-
<td rowspan="2">File Parsing</td>
45-
<td><a href="assets/example.mp3">example.mp3</a></td>
46-
<td><img src="assets/screenshots/uploads/SCR-20250727-uakj.png"></td>
47-
</tr>
48-
<tr>
49-
<td><img src="assets/screenshots/uploads/SCR-20250727-ujjl.png"></td>
50-
<td><img src="assets/screenshots/uploads/SCR-20250727-uanf.png">
51-
<img src="assets/screenshots/uploads/SCR-20250727-uaoi.png"></td>
52-
</tr>
53-
</table>
54-
55-
<table>
56-
<tr>
57-
<th>Feature</th>
58-
<th>Screenshot</th>
59-
</tr>
60-
<tr>
61-
<td>Q&A</td>
62-
<td><img src="assets/screenshots/chat/SCR-20250727-uder.png"></td>
63-
</tr>
64-
<tr>
65-
<td>Writing</td>
66-
<td><img src="assets/screenshots/chat/SCR-20250727-udta.png">
67-
<img src="assets/screenshots/chat/SCR-20250727-uegk.png"></td>
68-
</tr>
69-
<tr>
70-
<td>Markdown</td>
71-
<td><img src="assets/screenshots/markdown/SCR-20250727-ssnr.png">
72-
<img src="assets/screenshots/markdown/SCR-20250727-ssou.png">
73-
<img src="assets/screenshots/markdown/SCR-20250727-sspn.png">
74-
<img src="assets/screenshots/markdown/SCR-20250727-ssqi.png"></td>
75-
</tr>
76-
</table>
77-
78-
<table>
79-
<tr>
80-
<th>Feature</th>
81-
<th>Demo Video</th>
82-
</tr>
83-
<tr>
84-
<td>Flash - Voice Recording</td>
85-
<td><video src="https://github.com/user-attachments/assets/7d7c1089-5f7d-4575-b3cc-a2ee5effb3db" width="300"></video></td>
86-
</tr>
87-
<tr>
88-
<td>Flash - Text Note</td>
89-
<td><video src="https://github.com/user-attachments/assets/b31c6bbd-78b3-4808-8370-a93e16ff6ddd" width="300"></video></td>
90-
</tr>
91-
<tr>
92-
<td>Share Files to OmniBox</td>
93-
<td><video src="https://github.com/user-attachments/assets/0000f920-4028-4d3d-8024-e4fbfb78a77f" width="300"></video></td>
94-
</tr>
95-
</table>
96-
</details>
97-
9831
## Quick Start
9932

10033
Welcome to our online service: [omnibox.pro](https://www.omnibox.pro/?utm_source=gh_readme_en), supporting login via Email, Google and WeChat.
10134

10235
### Browser Extension
10336

104-
[Browser Extension Installation | OmniBox Docs](https://www.omnibox.pro/docs/collect/browser-extension)
37+
[Browser Extension Installation | OmniBox Docs](https://www.omnibox.pro/docs/browser-extension?utm_source=gh_readme_en)
10538

10639
### Deployment
10740

108-
```shell
109-
GIT_LFS_SKIP_SMUDGE=1 git clone https://github.com/import-ai/omnibox.git
110-
cd omnibox
111-
cp example.env .env
112-
bash scripts/compose.sh up -d
113-
```
41+
[Local Deployment](https://www.omnibox.pro/docs/deploy?utm_source=gh_readme_en)
11442

11543
### Local Development
11644

@@ -132,4 +60,3 @@ bash scripts/dev.sh up -d --build
13260
## Star History
13361

13462
[![Star History Chart](https://api.star-history.com/svg?repos=import-ai/omnibox&type=date&legend=top-left)](https://www.star-history.com/#import-ai/omnibox&type=date&legend=top-left)
135-

‎README_zh.md‎

Lines changed: 4 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77

88
[English](./README.md) | 简体中文
99

10+
<img width="923" height="620" alt="Image" src="https://github.com/user-attachments/assets/35dad1b4-5652-4f2f-8eac-38c49da0545f" />
11+
1012
## 文档
1113

1214
[小黑帮助文档](https://www.omnibox.pro/docs/zh-cn/?utm_source=gh_readme_zh)
@@ -28,91 +30,17 @@
2830
7. **微信助手**：在微信中随时随地将文件、网页、视频、语音、文字、聊天记录保存至小黑
2931
8. 用户、团队系统、权限、分享管理、多租户、多语言、暗色模式、移动端自适应等
3032

31-
### 截图
32-
33-
<details>
34-
<table>
35-
<tr>
36-
<th>功能</th>
37-
<th>源</th>
38-
<th>解析结果</th>
39-
</tr>
40-
<tr>
41-
<td>收藏网页</td>
42-
<td><img src="assets/screenshots/extension/SCR-20250727-uniy.png" alt="Source web"></td>
43-
<td><img src="assets/screenshots/extension/SCR-20250727-srzd.png" alt="Extension parsing result"></td>
44-
</tr>
45-
<tr>
46-
<td rowspan="2">文件解析</td>
47-
<td><a href="assets/example.mp3">example.mp3</a></td>
48-
<td><img src="assets/screenshots/uploads/SCR-20250727-uakj.png"></td>
49-
</tr>
50-
<tr>
51-
<td><img src="assets/screenshots/uploads/SCR-20250727-ujjl.png"></td>
52-
<td><img src="assets/screenshots/uploads/SCR-20250727-uanf.png">
53-
<img src="assets/screenshots/uploads/SCR-20250727-uaoi.png"></td>
54-
</tr>
55-
</table>
56-
57-
<table>
58-
<tr>
59-
<th>功能</th>
60-
<th>截图</th>
61-
</tr>
62-
<tr>
63-
<td>问答</td>
64-
<td><img src="assets/screenshots/chat/SCR-20250727-uder.png"></td>
65-
</tr>
66-
<tr>
67-
<td>写作</td>
68-
<td><img src="assets/screenshots/chat/SCR-20250727-udta.png">
69-
<img src="assets/screenshots/chat/SCR-20250727-uegk.png"></td>
70-
</tr>
71-
<tr>
72-
<td>Markdown</td>
73-
<td><img src="assets/screenshots/markdown/SCR-20250727-ssnr.png">
74-
<img src="assets/screenshots/markdown/SCR-20250727-ssou.png">
75-
<img src="assets/screenshots/markdown/SCR-20250727-sspn.png">
76-
<img src="assets/screenshots/markdown/SCR-20250727-ssqi.png"></td>
77-
</tr>
78-
</table>
79-
80-
<table>
81-
<tr>
82-
<th>功能</th>
83-
<th>演示视频</th>
84-
</tr>
85-
<tr>
86-
<td>闪记 - 语音录制</td>
87-
<td><video src="https://github.com/user-attachments/assets/7d7c1089-5f7d-4575-b3cc-a2ee5effb3db" width="300"></video></td>
88-
</tr>
89-
<tr>
90-
<td>闪记 - 文字笔记</td>
91-
<td><video src="https://github.com/user-attachments/assets/b31c6bbd-78b3-4808-8370-a93e16ff6ddd" width="300"></video></td>
92-
</tr>
93-
<tr>
94-
<td>分享文件至小黑</td>
95-
<td><video src="https://github.com/user-attachments/assets/0000f920-4028-4d3d-8024-e4fbfb78a77f" width="300"></video></td>
96-
</tr>
97-
</table>
98-
</details>
99-
10033
## 快速开始
10134

10235
欢迎使用我们的在线服务：[omnibox.pro](https://www.omnibox.pro/?utm_source=gh_readme_zh)，支持邮箱注册以及谷歌、微信登录。
10336

10437
### 浏览器插件
10538

106-
[浏览器插件安装 | 小黑帮助文档](https://www.omnibox.pro/docs/zh-cn/collect/browser-extension)
39+
[浏览器插件安装 | 小黑帮助文档](https://www.omnibox.pro/docs/zh-cn/browser-extension?utm_source=gh_readme_zh)
10740

10841
### 部署
10942

110-
```shell
111-
GIT_LFS_SKIP_SMUDGE=1 git clone https://github.com/import-ai/omnibox.git
112-
cd omnibox
113-
cp example.env .env
114-
bash scripts/compose.sh up -d
115-
```
43+
[本地部署](https://www.omnibox.pro/docs/zh-cn/deploy?utm_source=gh_readme_zh)
11644

11745
### 本地开发
11846

@@ -134,4 +62,3 @@ bash scripts/dev.sh up -d --build
13462
## Star History
13563

13664
[![Star History Chart](https://api.star-history.com/svg?repos=import-ai/omnibox&type=date&legend=top-left)](https://www.star-history.com/#import-ai/omnibox&type=date&legend=top-left)
137-

‎backend‎

Submodule backend updated 23 files

‎web‎

Submodule web updated 30 files

‎wizard‎

0 commit comments

Comments
 (0)