Skip to content

An Obsidian plugin that lets you browse the web within Obsidian.

License

Notifications You must be signed in to change notification settings

PKM-er/Obsidian-Surfing

Repository files navigation

Surfing

中文文档English Doc

Introduction

An Obsidian plugin that allows you to browse the web within Obsidian using v1.0 tabs.

The core functionality of the plugin, rendering a web view, is greatly influenced by Ellpeck's Obsidian Custom Frames plugin and this plugin wouldn't have been possible without it.

TODO

  • Support extensions
  • Support custom CSS
  • Support custom JS

Feature

  • Core Feature
    • Browse arbitrary web pages: The plugin hijacks Obsidian's file, http, https protocols, enabling links to be opened directly in Obsidian, rather than in external browsers. Yes, local HTML and other resources are also supported.
    • Editor web search: You can select keywords in the editor and then right-click to open them in web-browser and search using the default search engine.
    • In-page web search: Again, you can right-click within a web page to use the default search engine search.
    • Copy links pointing to highlights: As with the browser, you can select text and copy the links pointing to it.
    • Use BookmarkLets in your browser to open the URL directly in Obsidian.
    • Copy video timestamp (experimental feature: currently only bilibili is supported): right click on the text to pop up the menu to copy the timestamp, currently there are some bugs, it is known that sometimes the menu does not pop up.
  • Auxiliary Feature
    • Open current URL with external browser: right-click menu
    • Default search engine: setting item
    • Default copy highlighted template: setting item (currently only supports very simple templates), please avoid using some special characters
    • Support browsing history: Jump back and forth to the page
    • Clear browsing history: command panel
    • All links are opened in the same panel on the right: Settings
    • Toggle whether to open in the same panel on the right: command panel
    • Simple dark mode: just simple

Usage

Use BookmarkLets Open URL

The plugin registers an Obsidain uri protocol that allows you to open eb-broswer in Obsidian using the URL obsidian://web-open?url=<url>. Where <url> refers to the web address link. Match bookmarklets will be able to click a bookmark in the browser to open the current browser URL within Obsidain.

  1. Open the Open URL In Obsidian Web option in the plugin settings.
  2. Under this option there is a link of bookmarklets, drag this link into your browser's bookmark bar. You can also click this link(will copy bookmarklets code), then create bookmarklets by yourself.
  3. Now you can click on the bookmark to open the current page of your browser in Obsidian.

Use Quickadd to search selection in ChatGPT in Surfing

  1. Create a macro based on this script: search-in-surfing
  2. Open ChatGPT in surfing, and select some text, then run the macro.

Installation

  • Not ready for market yet
  • Can be installed via the Brat plugin
  • Manual installation
  1. Find the release page on this github page and click
  2. Download the latest release zip file
  3. Unzip it, copy the unzipped folder to the obsidian plugin folder, make sure there are main.js and manifest.json files in the folder
  4. Restart obsidian (do not restart also, you have to refresh plugin list), in the settings interface to enable the plugin
  5. Done!

Contribution

Support

If you are enjoying this plugin then please support my work and enthusiasm by buying me a coffee on https://www.buymeacoffee.com/boninall. .