mirror of
https://github.com/asyouplz/SpeechNote.git
synced 2026-07-22 16:30:31 +00:00
* refactor: address PR #8004 review comments and fix lint errors * fix: address CI failures and code review feedback * Refactor: comprehensive fix for lint errors and type safety regressions * chore: trigger CI and Claude Code Review workflows
2 KiB
2 KiB
SpeechNote Documentation
English
Overview
SpeechNote is an Obsidian plugin that transcribes audio files into notes. You can use OpenAI Whisper or Deepgram as the transcription provider. Some features (such as speaker diarization) depend on the selected provider and settings.
Quick start
- Install the plugin from Obsidian Community Plugins (recommended), or install manually from the GitHub release files.
- Open Obsidian Settings and select Speech to Text.
- Add your API key(s) for the provider you want to use.
- Run the command "Transcribe audio file" from the command palette or file context menu.
Documentation map
- Settings: see SETTINGS.md for configuration options and recommendations.
- Troubleshooting: see TROUBLESHOOTING.md for common issues and fixes.
- Privacy: see PRIVACY.md for data flow and privacy considerations.
Support
If you need help, use GitHub Issues for bugs and GitHub Discussions for questions.
한국어
개요
SpeechNote는 Obsidian에서 오디오 파일을 텍스트로 변환하는 플러그인입니다. OpenAI Whisper 또는 Deepgram을 변환 공급자로 사용할 수 있습니다. 화자 분리처럼 일부 기능은 공급자와 설정에 따라 달라질 수 있습니다.
빠른 시작
- Obsidian 커뮤니티 플러그인에서 설치하는 것을 권장합니다.
- Obsidian 설정에서 Speech to Text를 선택합니다.
- 사용할 공급자의 API 키를 입력합니다.
- 명령 팔레트 또는 파일 컨텍스트 메뉴에서 "Transcribe audio file"을 실행합니다.
문서 안내
- 설정: SETTINGS.md에서 옵션과 권장 설정을 확인하세요.
- 문제 해결: TROUBLESHOOTING.md에서 흔한 문제와 해결 방법을 확인하세요.
- 개인정보: PRIVACY.md에서 데이터 흐름과 개인정보 관련 안내를 확인하세요.
지원
버그는 GitHub Issues, 질문은 GitHub Discussions를 이용해 주세요.