Skip to content

codedthinking/obsidian-streaming

Repository files navigation

Streaming for Obsidian

Broadcast the active note to remote viewers as beautifully rendered HTML with live edits, cursor, and scroll sync.

How it works

  1. Open a note in Obsidian.
  2. Run Streaming: Start sharing this note from the command palette.
  3. A URL is copied to your clipboard and the viewer opens in your browser.
  4. Share the URL with anyone — they see the note rendered live, updating with every keystroke.

Setup

The plugin streams to a relay server that renders and serves the content to viewers. You need a relay URL configured in settings.

  1. Install the plugin (see below).
  2. Go to Settings → Streaming → set the Relay server URL (e.g., wss://coauthors.md).
  3. Start sharing.

Installation

Via BRAT (recommended)

  1. Install BRAT from Community Plugins.
  2. BRAT → Add Beta Plugin → codedthinking/obsidian-streaming.
  3. Enable the plugin.

Manual

  1. Download main.js, manifest.json, and styles.css from the latest release.
  2. Create .obsidian/plugins/obsidian-streaming/ in your vault.
  3. Copy the three files into that directory.
  4. Reload Obsidian and enable the plugin.

Commands

  • Streaming: Start sharing this note — connects to the relay, copies the viewer URL, opens it in your browser.
  • Streaming: Stop sharing this note — disconnects the active note's session.
  • Streaming: Stop all sharing — stops all sessions.

Features

  • Real-time edit streaming — every keystroke appears in the viewer instantly.
  • Synced cursor overlay and scroll position.
  • Light and dark theme sync from Obsidian.
  • Multiple concurrent sessions (one per shared note).
  • Automatic reconnection with exponential backoff.

Settings

Setting Default Description
Relay server URL (empty) WebSocket URL of the relay. Required.
Auto-start sharing off Share every note you open.
Show remote cursor off Not yet implemented.

Limitations

  • Desktop only (requires Node.js WebSocket client).
  • Read-only broadcast — viewers cannot edit.
  • No authentication beyond the room ID in the URL.

License

MIT

About

Obsidian plugin: broadcast your notes as beautiful HTML to remote viewers

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors