Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/travisvn/obsidian-edge-tts
Free, high quality text-to-speech for your Obsidian notes, leveraging Microsoft Edge's Read Aloud API.
https://github.com/travisvn/obsidian-edge-tts
edge-tts obsidian obsidian-md obsidian-plugin speech text-to-speech tts
Last synced: 7 days ago
JSON representation
Free, high quality text-to-speech for your Obsidian notes, leveraging Microsoft Edge's Read Aloud API.
- Host: GitHub
- URL: https://github.com/travisvn/obsidian-edge-tts
- Owner: travisvn
- License: gpl-3.0
- Created: 2024-10-27T01:23:27.000Z (about 2 months ago)
- Default Branch: master
- Last Pushed: 2024-11-27T01:05:58.000Z (27 days ago)
- Last Synced: 2024-11-27T02:18:21.224Z (27 days ago)
- Topics: edge-tts, obsidian, obsidian-md, obsidian-plugin, speech, text-to-speech, tts
- Language: TypeScript
- Homepage: https://tts.travisvn.com
- Size: 122 KB
- Stars: 20
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Obsidian Edge TTS Plugin 🗣️
Free high-quality text-to-speech (narration) in Obsidian
## Overview
The **Obsidian Edge TTS Plugin** is a community plugin for [Obsidian](https://obsidian.md/) 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](https://tts.travisvn.com))
## Installation
1. Open Obsidian
2. Go to **Settings** → **Community Plugins**
3. Search for **Edge TTS**
4. Click **Install** and then **Enable**
Alternatively, you can manually download the latest release from [GitHub Releases](https://github.com/travisvn/obsidian-edge-tts/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 **Settings** → **Community Plugins** → **Edge 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](https://tts.travisvn.com) to sample available voices.
## If you like this project, please [give it a star on GitHub](https://github.com/travisvn/obsidian-edge-tts) ⭐️