Skip to content

Commit d0f6b02

Browse files
authored
Merge pull request #29 from refly-ai/marcus
Revise the document structure and incorporate an operations manual.
2 parents 4c4dbec + e45cda7 commit d0f6b02

File tree

172 files changed

+3007
-16
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

172 files changed

+3007
-16
lines changed

.vitepress/config.ts

Lines changed: 129 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -34,20 +34,78 @@ const sidebar = {
3434
en: [
3535
{
3636
text: "Getting Started",
37-
items: [{ text: "Welcome to Refly", link: "/" }],
37+
items: [
38+
{ text: "Welcome to Refly", link: "/" }, // Points to index.md
39+
{ text: "Crash Course", link: "/guide/crash-course" },
40+
{ text: "Introduction", link: "/guide/introduction" },
41+
{ text: "Video Tutorials", link: "/guide/video-tutorials" },
42+
// Core Concepts needs to be created
43+
// { text: "Core Concepts", link: "/getting-started/core-concepts" },
44+
],
3845
},
3946
{
40-
text: "Guide",
47+
text: "Cloud Version",
4148
items: [
42-
{ text: "Crash Course", link: "/guide/crash-course" },
49+
{
50+
text: "Feature Intro",
51+
items: [
52+
{ text: "Product Overview", link: "/cloud/feature-intro/" },
53+
{ text: "Ask AI", link: "/cloud/feature-intro/ask-ai" },
54+
{
55+
text: "Canvas and Nodes",
56+
link: "/cloud/feature-intro/canvas-nodes.md",
57+
},
58+
{
59+
text: "Creation Toolbar",
60+
link: "/cloud/feature-intro/creation-toolbar",
61+
},
62+
{
63+
text: "Global Search",
64+
link: "/cloud/feature-intro/global-search",
65+
},
66+
{
67+
text: "Knowledge Base",
68+
link: "/cloud/feature-intro/knowledge-base",
69+
},
70+
{ text: "Templates", link: "/cloud/feature-intro/templates" },
71+
{ text: "UI Overview", link: "/cloud/feature-intro/ui-overview" },
72+
],
73+
},
74+
{ text: "Chrome Extension", link: "/cloud/chrome-extension" },
75+
],
76+
},
77+
{
78+
text: "Community Version",
79+
items: [
80+
{ text: "Community Version Overview", link: "/community-version/" },
4381
{
4482
text: "Self-Deploy",
45-
link: "/guide/self-deploy",
46-
items: [{ text: "Ollama", link: "/guide/self-deploy/ollama" }],
83+
items: [
84+
{
85+
text: "Deployment Guide",
86+
link: "/community-version/self-deploy/",
87+
},
88+
{
89+
text: "Ollama Integration",
90+
link: "/community-version/self-deploy/ollama",
91+
},
92+
{
93+
text: "Configuration Guide",
94+
link: "/community-version/self-deploy/configuration",
95+
},
96+
],
97+
},
98+
{ text: "FAQ", link: "/community-version/faq" },
99+
],
100+
},
101+
{
102+
text: "Scenarios",
103+
items: [
104+
{ text: "Scenarios", link: "/scenarios/" },
105+
{
106+
text: "Create Tech PPT in 15 mins",
107+
link: "/scenarios/create-tech-ppt",
47108
},
48-
{ text: "Configuration", link: "/guide/configuration" },
49-
{ text: "Chrome Extension", link: "/guide/chrome-extension" },
50-
{ text: "Video Tutorials", link: "/guide/video-tutorials" },
51109
],
52110
},
53111
{
@@ -86,20 +144,72 @@ const sidebar = {
86144
zh: [
87145
{
88146
text: "入门",
89-
items: [{ text: "欢迎使用 Refly", link: "/zh" }],
147+
items: [
148+
{ text: "欢迎使用 Refly", link: "/zh/" }, // 指向 zh/index.md
149+
{ text: "快速上手", link: "/zh/guide/crash-course" },
150+
{ text: "入门介绍", link: "/zh/guide/introduction" },
151+
{ text: "视频教程", link: "/zh/guide/video-tutorials" },
152+
// 核心概念需要新建文件后添加链接
153+
// { text: "核心概念", link: "/zh/getting-started/core-concepts" },
154+
],
90155
},
91156
{
92-
text: "指南",
157+
text: "云版本",
93158
items: [
94-
{ text: "快速上手", link: "/zh/guide/crash-course" },
159+
{
160+
text: "功能介绍",
161+
items: [
162+
{ text: "功能介绍概览", link: "/zh/cloud/feature-intro/" }, // 指向 zh/cloud/feature-intro/index.md
163+
{ text: "问问 AI", link: "/zh/cloud/feature-intro/ask-ai" },
164+
{
165+
text: "画布和节点",
166+
link: "/zh/cloud/feature-intro/canvas-nodes.md",
167+
},
168+
{
169+
text: "创作工具栏",
170+
link: "/zh/cloud/feature-intro/creation-toolbar",
171+
},
172+
{ text: "全局搜索", link: "/zh/cloud/feature-intro/global-search" },
173+
{ text: "知识库", link: "/zh/cloud/feature-intro/knowledge-base" },
174+
{ text: "模板", link: "/zh/cloud/feature-intro/templates" },
175+
{
176+
text: "右上角界面概览",
177+
link: "/zh/cloud/feature-intro/ui-overview",
178+
},
179+
],
180+
},
181+
{ text: "Chrome 插件", link: "/zh/cloud/chrome-extension" },
182+
],
183+
},
184+
{
185+
text: "社区版本",
186+
items: [
187+
{ text: "社区版本概览", link: "/zh/community-version/" },
95188
{
96189
text: "私有部署",
97-
link: "/zh/guide/self-deploy/index",
98-
items: [{ text: "Ollama", link: "/zh/guide/self-deploy/ollama" }],
190+
items: [
191+
{ text: "部署指南", link: "/zh/community-version/self-deploy/" },
192+
{
193+
text: "Ollama 集成",
194+
link: "/zh/community-version/self-deploy/ollama",
195+
},
196+
{
197+
text: "配置指南",
198+
link: "/zh/community-version/self-deploy/configuration",
199+
},
200+
],
201+
},
202+
{ text: "常见问题", link: "/zh/community-version/faq" },
203+
],
204+
},
205+
{
206+
text: "场景分享",
207+
items: [
208+
{ text: "场景分享", link: "/zh/scenarios/" },
209+
{
210+
text: "15分钟快速制作一份技术架构PPT",
211+
link: "/zh/scenarios/create-tech-ppt",
99212
},
100-
{ text: "配置", link: "/zh/guide/configuration" },
101-
{ text: "Chrome 插件", link: "/zh/guide/chrome-extension" },
102-
{ text: "视频教程", link: "/zh/guide/video-tutorials" },
103213
],
104214
},
105215
{
@@ -145,6 +255,9 @@ export default defineConfig({
145255
// Remove .html extensions from URLs
146256
cleanUrls: true,
147257

258+
// Ignore dead links in README.md and other files
259+
ignoreDeadLinks: true,
260+
148261
// Configure head
149262
head: [
150263
["link", { rel: "icon", href: "/logo/logo.svg" }],

cloud/chrome-extension.md

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
# Refly AI Chrome Extension Guide
2+
3+
The Refly Chrome extension is a powerful personal content management tool that helps you easily collect, organize, and save valuable content from any webpage to your knowledge base. Whether it's article paragraphs, important notes, or complete webpages, you can save them with one click and build your second brain.
4+
5+
## Installation
6+
7+
1. Visit the [Chrome Web Store](https://chromewebstore.google.com/detail/lecbjbapfkinmikhadakbclblnemmjpd)
8+
2. Click the "Add to Chrome" button
9+
3. Confirm the installation when prompted
10+
11+
## Features
12+
13+
### 1. Webpage Content Saving Modes
14+
15+
#### 1.1 Text Selection Saving
16+
- Find the Refly floating ball on the right side of the webpage
17+
- Enable selection mode to choose content you want to save
18+
- After selection, choose to save or clip to your knowledge base
19+
- Support multiple selections and cumulative saving
20+
21+
<div style="padding: 20px 0;">
22+
<video width="100%" style="border-radius: 10px;" autoplay loop muted playsinline>
23+
<source src="https://static.refly.ai/extension/text_selection_clip.mp4" type="video/mp4">
24+
</video>
25+
</div>
26+
27+
#### 1.2 One-Click Page Saving
28+
- Save the entire webpage content through the right-side floating ball
29+
- Automatically extract main content, filtering out ads and irrelevant information
30+
- Preserve original formatting and images
31+
32+
<div style="padding: 20px 0;">
33+
<video width="100%" style="border-radius: 10px;" autoplay loop muted playsinline>
34+
<source src="https://static.refly.ai/extension/whole_page_clip.mp4" type="video/mp4">
35+
</video>
36+
</div>
37+
38+
#### 1.3 Popup Window Operations
39+
- Click the Refly icon in the browser's top-right corner
40+
- View and edit content to be saved in the popup window
41+
- Support content preview and quick editing
42+
43+
<div style="padding: 20px 0;">
44+
<video width="100%" style="border-radius: 10px;" autoplay loop muted playsinline>
45+
<source src="https://static.refly.ai/extension/popup_clip.mp4" type="video/mp4">
46+
</video>
47+
</div>
48+
49+
#### 1.4 Clipboard Enhancement
50+
- Support copying any content to clipboard
51+
- Paste and supplement content in the popup window
52+
- Support rich text format saving
53+
54+
<div style="padding: 20px 0;">
55+
<video width="100%" style="border-radius: 10px;" autoplay loop muted playsinline>
56+
<source src="https://static.refly.ai/extension/clipboard_clip_and_save.mp4" type="video/mp4">
57+
</video>
58+
</div>
59+
60+
### 2. Knowledge Base Integration
61+
62+
#### Content Processing Flow
63+
1. Clipped content is automatically saved to your knowledge base
64+
2. Support converting saved content into document format
65+
3. Edit, organize, and tag saved content
66+
4. Support selecting partial content for note creation or AI queries
67+
68+
## Supported Platforms
69+
70+
Refly supports content saving from various popular platforms, including:
71+
72+
### Social Media
73+
- [Twitter/X](https://twitter.com)
74+
- [Reddit](https://reddit.com)
75+
- [LinkedIn](https://www.linkedin.com)
76+
- [Xiaohongshu](https://xiaohongshu.com/explore)
77+
- [Zhihu](https://www.zhihu.com)
78+
- [Douban](https://www.douban.com)
79+
- [Juejin](https://juejin.cn)
80+
81+
### Academic Research
82+
- [Google Scholar](https://scholar.google.com)
83+
- [arXiv](https://arxiv.org)
84+
- [ResearchGate](https://www.researchgate.net)
85+
- [SSRN](https://www.ssrn.com)
86+
87+
### Tech Communities
88+
- [GitHub](https://github.com)
89+
- [Stack Overflow](https://stackoverflow.com)
90+
- [Dev.to](https://dev.to)
91+
- [HackerNews](https://news.ycombinator.com)
92+
93+
### Productivity Tools
94+
- [Notion](https://notion.so)
95+
- [Obsidian](https://obsidian.md)
96+
- [Logseq](https://logseq.com)
97+
- [Readwise](https://readwise.io)
98+
99+
### Others
100+
101+
These are just some of the main platforms. Refly supports saving content from any webpage, allowing you to save whatever interests you.
102+
103+
## Best Practices
104+
105+
1. **Selective Saving**: Only save content that's valuable to you, avoid information overload
106+
2. **Timely Organization**: Regularly organize saved content to build your knowledge system
107+
3. **Privacy Protection**: Your data is securely encrypted and stored
108+
4. **Regular Review**: Periodically review and organize your saved content
109+
110+
## Troubleshooting
111+
112+
If you encounter any issues:
113+
114+
1. Ensure the extension is up to date
115+
2. Check browser compatibility
116+
3. Clear browser cache
117+
4. Restart the browser
118+
5. Contact support team if problems persist
119+
120+
## Getting Help
121+
122+
If you need assistance:
123+
124+
- Visit our [Community page](/community/contact-us)
125+
- Check the [Changelog](/changelog/v0.2.4) for latest updates
126+
- Join our Discord community for real-time support
127+
- Contact our support team for technical issues

0 commit comments

Comments
 (0)