Skip to content

Free, high quality text-to-speech for your Obsidian notes, leveraging Microsoft Edge's Read Aloud API.

License

Notifications You must be signed in to change notification settings

travisvn/obsidian-edge-tts

Repository files navigation

Obsidian Edge TTS Plugin 🗣️

GitHub stars Obsidian downloads GitHub release GitHub issues GitHub last commit Hits Discord

Free high-quality text-to-speech (narration) in Obsidian

Overview

The Obsidian Edge TTS Plugin is a community plugin for Obsidian that allows you to read your notes aloud using Microsoft's Edge TTS API. It supports a variety of voices and locales, making it an excellent tool for users who want to listen to their notes while multitasking or to improve accessibility.

Features

  • Read selected text or entire notes aloud
  • Choose from a list of top voices or specify a custom voice
  • Adjust playback speed of voice over
  • Toggle optional notices for playback status
  • Option to generate mp3 file and embed it directly in note
  • Listen to voice samples before selecting a voice (via tts.travisvn.com)

Installation

Install Obsidian plugin

  1. Open Obsidian
  2. Go to SettingsCommunity Plugins
  3. Search for Edge TTS
  4. Click Install and then Enable

Alternatively, you can manually download the latest release from GitHub Releases

Usage

  • Open the note you want to read aloud (or select the text)
  • Use the Read note aloud command from the command palette
    • or Click the ribbon icon (if enabled)
    • or Playback button in the status bar — this both starts a narration and then allows you to pause or resume once it's started
    • or Right-click on a file and select Read note aloud
  • New ✨ Right-click on a file and select Generate MP3 to save the narration to an mp3 and embed it in the note

Settings

To access the plugin settings:

  1. Go to SettingsCommunity PluginsEdge TTS.

  2. Configure the following options:

    • Select voice: Choose from a list of top voices.
    • Custom voice: Manually enter a custom voice.
    • Playback speed: Adjust playback speed multiplier.
    • Show notices: Toggle notices for playback status and errors.
    • Show status bar button: Toggle playback button in status bar.
    • Generate MP3: Toggle settings related to the Generate MP3 menu option.
    • Voice Samples: Visit tts.travisvn.com to sample available voices.

    Obsidian Edge TTS Plugin Settings Screenshot

If you like this project, please give it a star on GitHub ⭐️