Skip to content

Commit 08b84e3

Browse files
n4ze3mn4ze3m
authored
Merge pull request #404 from n4ze3m/next
v1.5.1
2 parents 599a477 + 9e0290d commit 08b84e3

Some content is hidden

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

67 files changed

+1124
-330
lines changed

‎.gitignore

+3-1
Original file line numberDiff line numberDiff line change
@@ -45,4 +45,6 @@ keys.json
4545
# WXT
4646
.wxt
4747
# WebStorm
48-
.idea
48+
.idea
49+
50+
/docs/.vitepress/cache/

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ This will start a development server and watch for changes in the source files.
113113
| Brave | ✅ | ✅ | ✅ |
114114
| Firefox | ✅ | ✅ | ✅ |
115115
| Vivaldi | ✅ | ✅ | ✅ |
116-
| Edge | ✅ | ❌ | ✅ |
116+
| Edge | ✅ | ✅ | ✅ |
117117
| LibreWolf | ✅ | ✅ | ✅ |
118118
| Zen Browser | ✅ | ✅ | ✅ |
119119
| Opera | ❌ | ❌ | ✅ |

‎bun.lockb

49.9 KB
Binary file not shown.

‎docs/.vitepress/config.mts

+86
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
import { defineConfig } from 'vitepress'
2+
3+
// https://vitepress.dev/reference/site-config
4+
export default defineConfig({
5+
title: "Page Assist",
6+
description: "Page Assist is an open-source Chrome Extension that provides a Sidebar and Web UI for your Local AI model. It allows you to interact with your model from any webpage.",
7+
lastUpdated: true,
8+
themeConfig: {
9+
// https://vitepress.dev/reference/default-theme-config
10+
search: {
11+
provider: "local",
12+
},
13+
editLink: {
14+
pattern: "https://github.com/n4ze3m/page-assist/edit/main/docs/:path",
15+
text: "Edit this page on GitHub"
16+
},
17+
nav: [
18+
{ text: 'Home', link: '/' },
19+
],
20+
21+
sidebar: [
22+
{
23+
text: 'Guide',
24+
items: [
25+
{ text: 'Welcome to Page Assist', link: '/' },
26+
{
27+
text: "Browser Support",
28+
link: "/browser-support"
29+
},
30+
{
31+
text: "Keyboard Shortcuts",
32+
link: "/shortcuts"
33+
}
34+
],
35+
},
36+
{
37+
text: "Sidebar",
38+
items: [
39+
{
40+
text: "Sidebar Settings",
41+
link: "/sidebar"
42+
},
43+
{
44+
text: "Sidebar Copilot",
45+
link: "/sidebar/copilot"
46+
}
47+
],
48+
},
49+
{
50+
text: "Providers",
51+
items: [
52+
{
53+
text: "Ollama",
54+
link: "/providers/ollama"
55+
},
56+
{
57+
text: "LM Studio",
58+
link: "/providers/lmstudio"
59+
},
60+
{
61+
text: "OpenAI Compatible API",
62+
link: "/providers/openai"
63+
}
64+
]
65+
},
66+
{
67+
text: "Troubleshooting",
68+
items: [
69+
{
70+
text: "Ollama Connection Issue",
71+
link: "/connection-issue"
72+
}
73+
]
74+
}],
75+
76+
socialLinks: [
77+
{ icon: 'github', link: 'https://github.com/n4ze3m/page-assist' },
78+
{ icon: 'x', link: 'https://x.com/page_assist' },
79+
{ icon: 'discord', link: 'https://discord.gg/bu54382uBd' },
80+
],
81+
footer: {
82+
message: "MIT Licensed Open Source Project",
83+
copyright: "Copyright © 2025 Muhammed Nazeem & Page Assist Contributors",
84+
},
85+
},
86+
})

‎docs/api-examples.md

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
outline: deep
3+
---
4+
5+
# Runtime API Examples
6+
7+
This page demonstrates usage of some of the runtime APIs provided by VitePress.
8+
9+
The main `useData()` API can be used to access site, theme, and page data for the current page. It works in both `.md` and `.vue` files:
10+
11+
```md
12+
<script setup>
13+
import { useData } from 'vitepress'
14+
15+
const { theme, page, frontmatter } = useData()
16+
</script>
17+
18+
## Results
19+
20+
### Theme Data
21+
<pre>{{ theme }}</pre>
22+
23+
### Page Data
24+
<pre>{{ page }}</pre>
25+
26+
### Page Frontmatter
27+
<pre>{{ frontmatter }}</pre>
28+
```
29+
30+
<script setup>
31+
import { useData } from 'vitepress'
32+
33+
const { site, theme, page, frontmatter } = useData()
34+
</script>
35+
36+
## Results
37+
38+
### Theme Data
39+
<pre>{{ theme }}</pre>
40+
41+
### Page Data
42+
<pre>{{ page }}</pre>
43+
44+
### Page Frontmatter
45+
<pre>{{ frontmatter }}</pre>
46+
47+
## More
48+
49+
Check out the documentation for the [full list of runtime APIs](https://vitepress.dev/reference/runtime-api#usedata).

‎docs/browser-support.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Browser Support
2+
3+
For the best experience, we recommend using Page Assist with the latest versions of Google Chrome, Microsoft Edge, or Firefox.
4+
5+
6+
## Supported Browsers
7+
8+
| Browser | Sidebar | Chat With Webpage | Web UI |
9+
| ----------- | ------- | ----------------- | ------ |
10+
| Chrome | ✅ | ✅ | ✅ |
11+
| Brave | ✅ | ✅ | ✅ |
12+
| Firefox | ✅ | ✅ | ✅ |
13+
| Vivaldi | ✅ | ✅ | ✅ |
14+
| Edge | ✅ | ✅ | ✅ |
15+
| LibreWolf | ✅ | ✅ | ✅ |
16+
| Zen Browser | ✅ | ✅ | ✅ |
17+
| Opera | ❌ | ❌ | ✅ |
18+
| Arc | ❌ | ❌ | ✅ |

‎docs/connection-issue.md

+41-9
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ Connection issues can be caused by a number of reasons. Here are some common iss
88
### 2. `403` Error When Sending a Message
99
![403 error when sending a message](https://image.pageassist.xyz/Screenshot%202024-05-13%20001940.png)
1010

11-
This issue usually occurs when Ollama is not running on [http://127.0.0.1:11434/](http://127.0.0.1:11434/), and the connection is from the private network or a different network.
11+
This issue because of CORS (Cross-Origin Resource Sharing) issues. Since Page Assist is a browser extension, it needs to communicate with the server through the browser. However, the browser restricts communication between different origins. To resolve this issue, you can try the following solutions:
1212

13-
### Solutions
13+
## 1. Solutions
1414

1515
Since Ollama has connection issues when directly accessed from the browser extension, Page Assist rewrites the request headers to make it work. However, automatic rewriting of headers only works on `http://127.0.0.1:*` and `http://localhost:*` URLs. To resolve the connection issue, you can try the following solutions:
1616

@@ -26,17 +26,49 @@ Since Ollama has connection issues when directly accessed from the browser exten
2626

2727
![Enable or Disable Custom Origin URL](https://image.pageassist.xyz/Screenshot%202024-05-13%20003225.png)
2828

29-
5. (Optional) If Ollama is running on a different port or host, then change the URL in the `Custom Origin URL` field; otherwise, leave it as it is.
29+
:::tip
30+
If Ollama is running on a different port or host, then change the URL in the `Custom Origin URL` field; otherwise, leave it as it is. But you need to enable it - do not change the URL
31+
:::
3032

31-
6. Make sure click on the `Save` button to save the changes.
33+
5. Make sure click on the `Save` button to save the changes.
3234

33-
This will resolve the connection issue, and you will be able to use Ollama without any issues on Page Assist ❤
35+
_This will resolve the connection issue, and you will be able to use Ollama without any issues on Page Assist_
3436

35-
7. If you are still facing issues, you can try the following steps:
37+
## 2. Solution
38+
39+
You can set OLLAMA_ORIGIN=* to allow connections from any origin. Here's how to do it on different operating systems:
40+
41+
### Windows
42+
1. Open Start menu and search for "Environment Variables"
43+
2. Click "Edit the system environment variables"
44+
3. Click "Environment Variables" button
45+
4. Under "System Variables" click "New"
46+
5. Set Variable name: `OLLAMA_ORIGIN` and Variable value: `*`
47+
6. Click OK to save
48+
7. Restart Ollama service
49+
50+
51+
### MacOS
52+
53+
1. Open Terminal
54+
2. Run the following command:
55+
56+
```bash
57+
launchctl setenv OLLAMA_ORIGIN "*"
58+
```
59+
3. Restart Ollama service
60+
61+
### Linux
62+
1. Open Terminal
63+
2. Run the following command:
64+
65+
```bash
66+
export OLLAMA_ORIGIN="*"
67+
```
68+
3. Restart Ollama service
69+
70+
_This will allow connections from any origin. Hopefully, this will resolve the connection issue._
3671

37-
- Add `OLLAMA_HOST=0.0.0.0` to the environment variables of Ollama.
38-
- Restart Ollama.
39-
- Try again.
4072

4173

4274
If you still face any issues, feel free to contact us [here](https://github.com/n4ze3m/page-assist/issues/new), and we will be happy to help you out.

‎docs/index.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Welcome to Page Assist
2+
3+
Welcome to Page Assist, the browser companion for your Local AI model! With Page Assist, your web browsing experience enters a new dimension of intelligence and efficiency.
4+
5+
## Quick Start Guide
6+
7+
Page Assist makes AI interaction a breeze! Simply:
8+
- Chat with your AI from any webpage using our sleek Sidebar
9+
- Access the powerful Web UI control center
10+
- Connect to your favorite local AI models
11+
12+
## Get Page Assist Today!
13+
14+
Download for your favorite browser:
15+
16+
[![Chrome Web Store](https://pub-35424b4473484be483c0afa08c69e7da.r2.dev/UV4C4ybeBTsZt43U4xis.png)](https://chrome.google.com/webstore/detail/page-assist/jfgfiigpkhlkbnfnbobbkinehhfdhndo)
17+
18+
[![Firefox Add-on](https://pub-35424b4473484be483c0afa08c69e7da.r2.dev/get-the-addon.png)](https://addons.mozilla.org/en-US/firefox/addon/page-assist/)
19+
20+
[![Edge Add-on](https://pub-35424b4473484be483c0afa08c69e7da.r2.dev/edge-addon.png)](https://microsoftedge.microsoft.com/addons/detail/page-assist-a-web-ui-fo/ogkogooadflifpmmidmhjedogicnhooa)

‎docs/markdown-examples.md

+85
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
# Markdown Extension Examples
2+
3+
This page demonstrates some of the built-in markdown extensions provided by VitePress.
4+
5+
## Syntax Highlighting
6+
7+
VitePress provides Syntax Highlighting powered by [Shiki](https://github.com/shikijs/shiki), with additional features like line-highlighting:
8+
9+
**Input**
10+
11+
````md
12+
```js{4}
13+
export default {
14+
data () {
15+
return {
16+
msg: 'Highlighted!'
17+
}
18+
}
19+
}
20+
```
21+
````
22+
23+
**Output**
24+
25+
```js{4}
26+
export default {
27+
data () {
28+
return {
29+
msg: 'Highlighted!'
30+
}
31+
}
32+
}
33+
```
34+
35+
## Custom Containers
36+
37+
**Input**
38+
39+
```md
40+
::: info
41+
This is an info box.
42+
:::
43+
44+
::: tip
45+
This is a tip.
46+
:::
47+
48+
::: warning
49+
This is a warning.
50+
:::
51+
52+
::: danger
53+
This is a dangerous warning.
54+
:::
55+
56+
::: details
57+
This is a details block.
58+
:::
59+
```
60+
61+
**Output**
62+
63+
::: info
64+
This is an info box.
65+
:::
66+
67+
::: tip
68+
This is a tip.
69+
:::
70+
71+
::: warning
72+
This is a warning.
73+
:::
74+
75+
::: danger
76+
This is a dangerous warning.
77+
:::
78+
79+
::: details
80+
This is a details block.
81+
:::
82+
83+
## More
84+
85+
Check out the documentation for the [full list of markdown extensions](https://vitepress.dev/guide/markdown).

‎docs/providers/lmstudio.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# LM Studio
2+
3+
You can add LMStudio's API to Page Assist. Here's how you can do it:
4+
5+
1. Click on the Page Assist icon on the browser toolbar.
6+
7+
2. Click on the `Settings` icon.
8+
9+
3. Go to the `OpenAI Compatible API` tab.
10+
11+
4. Click on the `Add Provider` button.
12+
13+
5. Select `LMStudio` from the dropdown.
14+
15+
6. Enter the `LMStudio URL`. (by default it is `http://localhost:1234/v1`)
16+
17+
7. Click on the `Save` button.
18+
19+
20+
::: info
21+
You don't need to add any models since Page Assist will automatically fetch them from the LMStudio instance you have configured.
22+
23+
The model must be loaded in LMStudio before Page Assist can fetch it.
24+
:::

0 commit comments

Comments
 (0)