obsidian-plugin/xnjiang_speakpen-obsidian
1
0
Fork 0
mirror of https://github.com/xnjiang/speakpen-obsidian.git synced 2026-07-22 06:13:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
17 commits 2 branches 2 tags 70 KiB
TypeScript 95.8%
JavaScript 4.2%
Find a file
Claude b6f597077e
Prepare plugin for Obsidian community-plugin submission 
Ready the repo for a PR to obsidianmd/obsidian-releases:

- manifest.json: add authorUrl (https://speakpen.app), set a realistic
  minAppVersion (1.4.0 instead of the implausible 1.0.0), bump version to
  0.1.1, and tighten the description.
- Add versions.json (0.1.1 -> 1.4.0), which the directory expects.
- README: stop claiming "install from Community Plugins" (not listed yet) —
  reflect that it's pending, and add a Manual installation section.
- Sync package.json version to 0.1.1.

Build verified: `npm run build` type-checks clean and produces main.js.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01RuPQKZjVMjDJMhm78iahdB
2026-07-17 06:09:49 +00:00
docs/superpowers docs: add design spec and implementation plan 2026-03-28 08:37:05 +08:00
src fix: use sentence case for sync folder placeholder text 2026-03-29 17:16:06 +08:00
tests fix: address Obsidian review bot findings 2026-03-28 14:00:54 +08:00
.gitignore chore: scaffold Obsidian plugin project 2026-03-28 08:52:42 +08:00
esbuild.config.mjs chore: scaffold Obsidian plugin project 2026-03-28 08:52:42 +08:00
LICENSE docs: add README and MIT license 2026-03-28 09:17:28 +08:00
manifest.json Prepare plugin for Obsidian community-plugin submission 2026-07-17 06:09:49 +00:00
package-lock.json chore: scaffold Obsidian plugin project 2026-03-28 08:52:42 +08:00
package.json Prepare plugin for Obsidian community-plugin submission 2026-07-17 06:09:49 +00:00
README.md Prepare plugin for Obsidian community-plugin submission 2026-07-17 06:09:49 +00:00
tsconfig.json chore: scaffold Obsidian plugin project 2026-03-28 08:52:42 +08:00
versions.json Prepare plugin for Obsidian community-plugin submission 2026-07-17 06:09:49 +00:00
vitest.config.ts feat: add SpeakPen API client with pagination 2026-03-28 08:56:00 +08:00

README.md

SpeakPen Sync

Sync your SpeakPen voice summaries into your vault as Markdown notes.

Features

  • Auto Sync — Automatically pulls new ideas from SpeakPen on a configurable interval
  • Manual Sync — Trigger sync from the ribbon icon or command palette
  • Markdown Notes — Each idea becomes a Markdown file with YAML frontmatter
  • Smart Dedup — Only syncs new ideas; never overwrites existing notes
  • Status Bar — Shows last sync time at a glance

Setup

  1. Install SpeakPen Sync (once it is available in Settings → Community plugins → Browse, search for "SpeakPen"; until then, see Manual installation below)
  2. Enable it, then go to Settings → SpeakPen Sync
  3. Paste your API Token (generate one from SpeakPen web app → Settings → API Tokens)
  4. Configure sync folder and interval as needed

Manual installation

  1. Download main.js, manifest.json (and styles.css if present) from the latest release.
  2. Create a folder <your vault>/.obsidian/plugins/speakpen-sync/ and copy those files into it.
  3. Reload Obsidian and enable SpeakPen Sync under Settings → Community plugins.

Note Format

Each synced idea is saved as a Markdown file in your configured folder (default: SpeakPen/):

---
speakpen_id: "123"
title: "Meeting Notes"
category: "Meeting"
created_at: 2026-03-28T10:00:00Z
audio_url: "https://..."
synced_at: 2026-03-28T10:05:00Z
---

## Summary

(AI-generated summary)

## Transcript

(Full transcript)

Settings

Setting Default Description
API Token — Your SpeakPen API token
Sync Folder SpeakPen Vault folder for synced notes
Auto Sync On Enable automatic sync
Sync Interval 5 min How often to check for new ideas

Commands

  • SpeakPen: Sync now — Manually trigger a sync

Development

git clone https://github.com/xnjiang/speakpen-obsidian.git
cd speakpen-obsidian
npm install
npm run dev    # development build
npm run build  # production build
npm test       # run tests

License

MIT