/save-to-obsidian

A chrome extension to save stuff into obsidian

Primary LanguageTypeScript

Save to Obsidian - Web Extension

Save to Obsidian is a powerful browser extension that allows users to effortlessly scrape content from webpages and create structured notes in their Obsidian vaults. This extension is now available across multiple browsers, including Chrome and Firefox. with a modern development setup featuring Vite, TailwindCSS, and WebdriverIO.

Features

  • Quick Note Creation: Easily transform the content of any webpage into a structured Obsidian note with just a click.
  • Metadata Extraction: Automatically captures essential metadata like title, byline, and date.
  • Tags Handling: Auto-fetches site meta keywords for easy tagging in Obsidian.
  • Markdown Support: Converts content to Markdown format for seamless integration with Obsidian.
  • File Naming: Ensures clean, compliant file naming for system compatibility.

Installation

The extension can be downloaded from:

Setup

  1. Clone the repository:

    git clone https://github.com/nsttt/save-to-obsidian.git

  2. Navigate to the project directory:

    cd save-to-obsidian

  3. Install dependencies:

    pnpm install

Build and Run

  • To build the extension, run:

    pnpm build

  • Start a browser with the extension installed:

    # For Chrome
pnpm start:chrome
    # For Firefox
pnpm start:firefox

Usage

  1. Enable developer mode in your browser.
  2. Load the unpacked extension.
  3. Navigate to a webpage and use the context menu to activate "Save to Obsidian".
  4. The content will be saved as a markdown note in your Obsidian vault.

Development

This project is bundled with Vite for TypeScript development. Run a development build using:

pnpm dev

Testing

  • Component tests:

    pnpm test:component

  • E2E tests:

    pnpm test:e2e

Contributing

Contributions are welcome! For major changes, please open an issue first to discuss your ideas.

Acknowledgements