Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Blocklist and Page Summary documentation improvements #550

Merged
merged 2 commits into from
Oct 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/kagi/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Welcome to Kagi Search Help!

Welcome to Kagi Search Help! If you're new to Kagi Search, our [Quick Start](/kagi/getting-started/index.md) and [FAQs](/kagi/faq/faq.md) are great places to begin. If you can’t find an answer to your Kagi question, [ask the community](https://kagi.com/discord) or email us at **[email protected]**.
Welcome to Kagi Search Help! If you're new to Kagi Search, our [Quick Start](/kagi/getting-started/index.md) and [FAQs](/kagi/faq/faq.md) are great places to begin. If you cannot find an answer to your Kagi question, [ask the community](https://kagi.com/discord) or email us at [email protected].

To send a bug report or a feature suggestion, you can use [KagiFeedback.org](https://kagifeedback.org).

Expand All @@ -10,7 +10,8 @@ You can access our documentation in several ways:
- Click or tap the magnifying glass icon at the top of the screen and do a search.
- Use the **!help** [bang](/kagi/features/bangs.md) in Kagi Search. For example, searching in Kagi for [!help setting Kagi as default search engine](https://kagi.com/search?q=!help%20setting%20kagi%20as%20default%20search%20engine) will show you results containing our default search documentation.

Feedback about this Kagi Search documentation can be shared on our [Discord server](https://kagi.com/discord) in the **\#documentation** channel. We would love to hear your thoughts on anything we can fix or improve.
Feedback about this Kagi Search documentation can be shared on our [Discord server](https://kagi.com/discord).
We would love to hear your thoughts on anything we can fix or improve.

## About Kagi Search

Expand Down
7 changes: 4 additions & 3 deletions docs/kagi/support-and-community/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,16 @@ next:

Feel free to email our customer support at [[email protected]](mailto:[email protected]).

Or, email Kagi CEO, Vladimir Prelovac, at [[email protected]](mailto:[email protected]).
Alternatively, you can email Kagi CEO, Vladimir Prelovac, at [[email protected]](mailto:[email protected]).

## Kagi Community

We have a [Kagi Community Discord server](https://kagi.com/discord) where you can join our community for real-time discussion about the product and chat with other Kagi users.

Please use the **#introduce-yourself** channel to say hello and let everyone know a bit about you.
Please use the **#introduce-yourself** channel to say hello and let everyone know a bit about yourself.
You can also share your initial thoughts on Kagi search in this channel or create a more detailed post in the **#kagi-chat** channel.

We'd also love to hear your initial thoughts about Kagi Search on the **#first-impressions** channel.
We are always eager to hear what new users think of Kagi.

To make specific feature requests or bug reports, please use our [Kagi Search feedback forum](https://kagifeedback.org) rather than Discord.

Expand Down
91 changes: 73 additions & 18 deletions docs/orion/features/custom-blocklists.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,46 +4,66 @@
- [Default Blocklists](#default_blocklists)
- [Custom Blocklists](#custom_blocklists)
- [Updating Blocklists](#updating_blocklists)
- [Adding Blocklists](#adding_blocklists)
- [Adding Blocklists on macOS](#adding_blocklists_macos)
- [Adding Blocklists on iOS](#adding_blocklists_ios)
- [Impact of Number of Blocking Rules on Performance](#performance_chart)
- [Third-Party Blocklists](#third_party_blocklists)
- [Regional Blocklists](#regional_blocklists)
- [Personal Filters](#personal_filters)
- [Custom Filters](#custom-filters-customfilters)
- [Blocklist Syntax](#blocklist-syntax)
- [Contributing to Blocklists](#contributing_blocklists)

<a id="default_blocklists"></a>
## Default Blocklists {#default_blocklists}

To protect you from most ads and trackers, Orion for Mac includes the following blocklists by default:
- EasyList (Enabled)
- EasyPrivacy (Enabled)
- Fanboy's Annoyance (Disabled)
Orion includes the following blocklists by default.
The blocklists in **bold** are enabled by default and provide sufficient protection against most ads and trackers.
- **EasyList**
- **EasyPrivacy**
- **d3Host List by d3ward**
- Hagezi Light DNS Blocklist
- Fanboy's Annoyance
- Hagezi Pro Plus Mini
- Privacy Essentials
- Block third-party fonts

You can enable or disable these blocklists in **Orion** > **Settings** > **Privacy**, then click the **Show Filter Lists** button.
On macOS, you can enable or disable these blocklists in **Orion** > **Settings** > **Privacy**, then click the **Manage Filter Lists...** button.

On iOS, the blocklists can be managed in the settings: **⋯** > **Settings** > Scroll down to **Content Blocker** and tap **Manage**.

<a id="custom_blocklists"></a>
## Custom Blocklists {#custom_blocklists}

Orion for Mac allows you to customize it's ad blocker by using custom blocklists. Blocklists are lists of domains that are known to serve ads, trackers, malware and other annoyances. Orion checks web page requests against these lists and blocks any requests to the listed domains. This prevents ads from being displayed and trackers from following you around.
In addition to the default blocklists, Orion allows you to customize its ad blocker by using custom blocklists.
Blocklists are lists of domains that are known to serve ads, trackers, malware and other annoyances.
Orion checks web page requests against these lists and blocks any requests to the listed domains.
This prevents ads from being displayed and trackers from following you around.


<a id="updating_blocklists"></a>
## Updating Blocklists {#updating_blocklists}

Blocklists are constantly updated as new ad/tracking domains appear. List maintainers work to identify and add new ad-serving domains as they pop up.

To manually update blocklists, go to **Orion** > **Settings** > **Privacy** and click **Update Now**. Wait for the "Processing update" message to disappear.
On macOS, to manually update blocklists, go to **Orion** > **Settings** > **Privacy** and click **Update Now**.
Wait for the "Processing update" message to disappear.

On iOS, blocklists can be updated in the settings: **⋯** > **Settings** > Scroll down to **Content Blocker** and tap **Update Now**.

<img src="./media/blocklists_update_now.png" width="500" alt="Orion macOS Blocklists - Update Now"><br />

<img src="./media/blocklists_update_now.png" width="500" alt="Blocklists - Update Now"><br />
<img src="./media/blocklists_processing_update.png" width="500" alt="Orion macOS Blocklists - Processing Update"><br />

<img src="./media/blocklists_procesing_update.png" width="500" alt="Blocklists - Processing Update"><br />
<img src="./media/ios_blocklists_update_now.png" width="500" alt="Orion iOS Blocklists - Update Now"><br />

<img src="./media/ios_blocklists_processing_update.png" width="500" alt="Orion iOS Blocklists - Processing Update"><br />

<a id="adding_blocklists"></a>
## Adding Blocklists {#adding_blocklists}
<a id="adding_blocklists_macos"></a>
## Adding Blocklists on macOS {#adding_blocklists_macos}

To add a blocklist to Orion, go to **Orion** > **Settings** > **Privacy** and click the **Show Filter Lists** button. Please note that Orion is compatible with Adblock Plus style blocklists.
To add a blocklist to Orion on macOS, go to **Orion** > **Settings** > **Privacy** and click the **Manage Filter Lists...** button.

Please note that Orion is compatible with Adblock Plus style blocklists.

<img src="./media/blocklists_settings_menu.png" width="500" alt="Blocklists - Settings Menu"><br />

Expand All @@ -59,6 +79,34 @@ Then, paste the URL of the blocklist you wish to add and click the **Add** butto

<img src="./media/blocklists_done.png" width="500" alt="Blocklists - Done"><br />

<a id="adding_blocklists_ios"></a>
## Adding Blocklists on iOS {#adding_blocklists_ios}

To add a blocklist to Orion on iOS, go to **⋯** > **Settings** > Scroll down to **Content Blocker** and tap **Manage** > **Add New**.

Before following the steps, it is advised to have the blocklist URL already copied to your clipboard.
Please note that Orion is compatible with Adblock Plus style blocklists.

<img src="./media/ios_blocklists_settings_menu.png" width="500" alt="iOS Blocklists - Settings Menu"><br />
<img src="./media/ios_blocklists_settings_menu2.png" width="500" alt="iOS Blocklists - Settings Menu step 2"><br />

Scroll down to the **Content Blocker** section of the settings and tap **Manage**.

<img src="./media/ios_blocklists_show_filter_lists.png" width="500" alt="iOS Blocklists - Show Filter Lists"><br />

In the **Manage Content Blocker** window, click the **Add New** button.

<img src="./media/ios_blocklists_add_blocklist.png" width="500" alt="iOS Blocklists - Add Blocklist"><br />

Then, paste the URL of the blocklist you wish to add and tap the **Done** button in the top right corner of the window.
Finally, tap **Done** in the Manage Content Blocker window.

The Custom Filter Name field can have any name you see fit.

<img src="./media/ios_blocklists_custom_url.png" width="500" alt="iOS Blocklists - Custom URL"><br />

<img src="./media/ios_blocklists_done.png" width="500" alt="iOS Blocklists - Done"><br />


<a id="performance_chart"></a>
## Impact of Number of Blocking Rules on Performance {#performance_chart}
Expand Down Expand Up @@ -235,13 +283,20 @@ ROList (Romanian) <br>
</details>


<a id="personal_filters"></a>
## Personal Filters {#personal_filters}
<a id="custom_filters"></a>
## Custom Filters {#custom_filters}

Orion allows you to create your own filters directly in Orion Settings.

On macOS, you can enable this feature in **Orion** > **Settings** > **Privacy** > **Manage Filter Lists**, then check the **Custom Filters** checkbox, and specify the rules in the text area.

Orion allows you to create your own filters directly in Orion Settings. You can enable this feature in **Orion** > **Settings** > **Privacy** > **Show Filter Lists**, then check the **Custom Filters** checkbox and specify the rules in the text area.
On iOS, custom filters can be added in the **Manage Content Blocker** window.
For example, users wishing to block ads on reddit could add `reddit.com##.promotedlink` into this section.
Once finished, tap **Done** in the top right corner of the window.

<img src="./media/blocklists_personal_filters.png" width="500" alt="Blocklists - Personal Filters"><br />
<img src="./media/blocklists_personal_filters.png" width="500" alt="Blocklists - Custom Filters"><br />

<img src="./media/ios_blocklists_custom_filters.png" width="500" alt="iOS Blocklists - Custom Filters"><br />

<a id="blocklist-syntax"></a>
## Blocklist Syntax {#blocklist-syntax}
Expand Down
Binary file modified docs/orion/features/media/blocklists_add_blocklist.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/orion/features/media/blocklists_custom_url.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/orion/features/media/blocklists_done.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/orion/features/media/blocklists_settings_menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/orion/features/media/blocklists_show_filter_lists.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/orion/features/media/blocklists_update_now.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
29 changes: 25 additions & 4 deletions docs/orion/features/summarize-page.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,15 @@

<br />

<video src="./media/macos_summarize_page.mp4" width="720" type="video/mp4" autoplay muted loop playsinline disablepictureinpicture />

Orion's integration with Kagi's [Universal Summarizer](https://help.kagi.com/kagi/ai/summarize-page.html) allows you to quickly generate concise summaries of lengthy web articles, saving you valuable time.

To summarize a page:
## macOS

<video src="./media/macos_summarize_page.mp4" width="720" type="video/mp4" autoplay muted loop playsinline disablepictureinpicture />

To summarize a page on macOS:

1. Ensure Kagi is set as the default search engine and you have an active Kagi membership.
1. Ensure Kagi is set as the default search engine and you have an active Kagi subscription.
2. Right-click anywhere on the page.
3. Select **Summarize Page**.

Expand All @@ -24,3 +26,22 @@ You can adjust the font and font size of the summary by clicking the **aA** butt

**Tip**: Use this feature to quickly grasp the main ideas of long articles, research papers, or news stories, enhancing your browsing efficiency.

## iOS

To summarize a page on iOS:

1. Make sure you have set Kagi as your search engine in Orion settings and that you have an active Kagi subscription.
2. Tap the website icon left of the address bar.
3. Select **Summarize This**.

This will open a Page Summary view of the current website.
The buttons at the bottom of this view allow you to modify the summary.

<img src="./media/ios_summarize_buttons.png" width="500" alt="Page Summary buttons on iOS"><br />

1. Choose the type of summary:
- **Summary** for a concise paragraph-style overview.
- **Key Moments** for a bullet-point summary highlighting the main points.
2. Choose the summary language. It is also possible to summarize documents in a language other than the original language.
3. Reload the summary.
4. Copy the summary to your device clipboard.
Loading