BeeRef Integration

unlisted

by Demiero

Open, edit and save BeeRef (.bee) reference boards inside Obsidian.

4 starsUpdated 22d agoGPL-3.0
View on GitHub
obsidian-beeref-banner

BeeRef Integration for Obsidian

Open, edit and save BeeRef (.bee) reference boards directly inside Obsidian.

Features

  • Open .bee files in a dedicated view: pan/zoom, move, scale, rotate, flip, crop, text notes, grayscale, opacity, undo/redo.
  • Autosave to the vault (~1s) after each change.
  • Paste or drag in images from outside Obsidian (files, browser images, or a copied URL).
  • ![[board.bee]] embeds render as a static preview thumbnail.

Install

Copy the beeref-board/ folder into <vault>/.obsidian/plugins/, then enable BeeRef Integration in Settings → Community plugins.

Build from Source

npm install
npm run build

This writes main.js. Copy it alongside manifest.json, styles.css, versions.json and assets/ into your vault's plugin folder.

Usage

  • Ribbon icon or Create new BeeRef board command creates an empty board.
  • Open a BeeRef board command opens a fuzzy picker over every .bee file in the vault.
  • Right-click the canvas for the context menu (cut/copy/paste, insert image, add text, ordering, flip, grayscale, opacity, crop).

Source Overview

  • src/beeFile.ts — SQLite (.bee) read/write via sql.js.
  • src/board.ts — the canvas engine (input handling, drawing, undo/redo, clipboard).
  • src/view.ts — the Obsidian FileView that hosts a board and handles autosave.
  • src/main.ts — plugin entry point: icon, ribbon, commands, embed rendering.
  • src/preview.ts — static thumbnail renderer used for ![[...]] embeds.
  • src/modals.ts — filename prompt and .bee file picker modals.
  • src/icon.ts — the custom ribbon/tab icon.

Credits & License

This Obsidian plugin includes a web port of BeeRef, originally created by its contributors.

This project is open-source and released under the GNU General Public License v3.0 (GPLv3) in accordance with the original software's license. See the LICENSE file for details.

For plugin developers

Search results and similarity scores are powered by semantic analysis of your plugin's README. If your plugin isn't appearing for searches you'd expect, try updating your README to clearly describe your plugin's purpose, features, and use cases.