Skip to content

Latest commit

 

History

History
80 lines (61 loc) · 2.49 KB

README.md

File metadata and controls

80 lines (61 loc) · 2.49 KB
Raw

Obsidian Bookmarks

Obsidian Bookmarks is a Firefox extension that allows you to save bookmarks as markdown files directly into your Obsidian vault.

✨ Features

  • Save bookmarks to sub-folders within your Obsidian vault.
  • Automatically grab the most relevant image from the bookmarked website.
  • Customize the template for your bookmark notes.

⚙️ Setup

On the welcome page (or in the extension settings), set the right vault name and you are ready to go!

💡 Tips

You can create a bookmarks viewer in Obsidian with the Minimal Theme, Dataview plugin, and this note:

---
cssclasses:
  - cards
  - cards-cover
  - cards-2-3
  - cards-cols-4
  - max
---

\`\`\`dataview
TABLE 
	WITHOUT id ("![](" + Cover + ")") AS Cover,
	("[" + Title + "](" + Link + ")") AS Title,
	Date,
	Tags[0] + ", " + Tags[1] + ", " + Tags[2]  AS Tags,
	("[[" + file.path + "| Edit ]]") AS Edit
FROM "Bookmarks"
SORT Title ASC
\`\`\`

(remove the backslashes before the triple backticks to use the code block)

🛠️ Development

Prerequisites

Installation

  1. Clone the repository:
git clone https://github.com/yourusername/obsidian-bookmarks.git
cd obsidian-bookmarks
  1. Load the extension in Firefox:
  • Open Firefox and go to about:debugging.
  • Click on "This Firefox" in the sidebar.
  • Click on "Load Temporary Add-on" and select the manifest.json file from the cloned repository.

File Structure

  • popup.html: The HTML file for the popup interface.
  • options.html: The HTML file for the options page.
  • styles/: Contains CSS files for styling the popup and options pages.
  • scripts/: Contains JavaScript files for the extension's functionality.
    • popup.js: Handles the logic for the popup interface.
    • options.js: Handles the logic for the options page.
    • content-script.js: Extracts images from the bookmarked page.
    • background.js: Manages background tasks and communication between scripts.
  • manifest.json: The manifest file for the Firefox extension.
  • mozilla.md: Documentation for the Mozilla add-ons page.

📝 Notes

  • This is a beta version, image grabbing may not work on all websites.
  • If the save button is not working, try reclicking it or refreshing the page.
  • This is an unofficial extension and is not affiliated with Obsidian.

Happy bookmarking!