Skip to content

Commit 8c5e1dc

Browse files
authored
docs(web): document v0.7.0 features on the website (#172)
* docs(web): document v0.7.0 features on the website Adds website coverage for features shipped since v0.6.2 (audit found 4 of 5 uncovered; Homebrew was already fully covered, left untouched): - New feature pages: Custom Vocabulary (#169) and Usage Statistics (#148/#168/#170), each with a landing-page grid card. - Landing JSON-LD featureList: add custom vocabulary, local usage stats, and selectable audio input device (#156). - Hotkey presets + custom recording (#139): fix stale "key combination" copy in fully-configurable.md, document the Record/custom-key capture and add the Right Control preset in push-to-talk.md, and update the FAQ. - Audio input device (#156): expand fully-configurable.md (System Default, non-invasive pinning, auto-fallback on disconnect, Refresh Devices). - Screenshots gallery: add a Stats tab entry. Two screenshots still needed from a real capture (marked with SCREENSHOT PLACEHOLDER comments): settings-stats.png and settings-vocabulary.png. Verified with `hugo` (build succeeds; new pages render; JSON-LD valid). * polish(web): refine features grid, fix mobile hero overflow, SEO pass Features grid: - Switch from a fixed 4-col grid (which left 2 orphan cards hanging and, via grid-auto-rows:1fr, forced every row to the tallest card's height) to a centered flex-wrap layout: uniform card heights, the short last row centers, and 4/2/1 columns at desktop/tablet/mobile. - Apple-style polish: icon squircle tiles, tighter 1–2 line copy on every card, softer corners, refined heading type, gentler hover. Mobile hero: - The 380px mockup forced the hero column wider than small viewports, clipping the subtext/pills/buttons. Reset min-width and clip the decorative mockup so nothing overflows below ~420px. SEO: - og:type now "article" for content pages (was always "website"). - Enriched the home and features-list meta descriptions. - Verified across all 18 pages: unique titles, one <h1> each, descriptions present, all <img> have alt, sitemap includes the new pages. Screenshots: add settings-stats.png and settings-vocabulary.png (referenced by the new feature pages) and refresh settings-general.png.
1 parent 77e1a6c commit 8c5e1dc

13 files changed

Lines changed: 132 additions & 31 deletions

File tree

web/content/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
22
title: "VocaMac - 100% Local Voice-to-Text for macOS"
3-
description: "100% offline, open-source voice-to-text for macOS. Powered by WhisperKit + CoreML."
3+
description: "Free, 100% offline voice-to-text for macOS. Hold a hotkey, speak, and text appears at your cursor — private, fast, and powered by WhisperKit on Apple Silicon."
44
keywords: "voice to text macOS, offline dictation, speech to text mac, whisperkit, coreml speech recognition, push to talk mac, open source dictation, privacy voice typing, apple silicon voice recognition"
55
---

web/content/features/_index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
22
title: "Features"
3-
description: "Everything VocaMac can do for you."
3+
description: "Explore every VocaMac feature — push-to-talk dictation, 99+ languages, custom vocabulary, usage stats, and more. 100% local voice-to-text for macOS."
4+
keywords: "vocamac features, voice to text features macOS, dictation app features, custom vocabulary, usage statistics, hotkey dictation"
45
---
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: "Custom Vocabulary"
3+
subtitle: "Teach VocaMac the names, brands, and jargon you use so they're transcribed right, every time."
4+
description: "Add names, technical terms, and jargon to VocaMac's custom vocabulary so Whisper spells them correctly. Processed 100% locally, like everything else in VocaMac."
5+
keywords: "custom vocabulary dictation, whisper glossary, proper noun transcription, technical jargon speech to text, fix misspelled names dictation macOS"
6+
icon: "📝"
7+
---
8+
9+
## Teach VocaMac Your Words
10+
11+
Speech models handle everyday language well but stumble on the words that matter most to you: coworkers' names, product names, acronyms, and technical jargon. "kubectl" becomes "cube control." "Grafana" becomes "graph on a." Every transcription ends with a manual fix.
12+
13+
Custom Vocabulary targets exactly the words you use. Give VocaMac a short list of the terms it keeps getting wrong, and it hints them to the model so they come out spelled correctly from the start.
14+
15+
<!-- SCREENSHOT PLACEHOLDER: add web/static/screenshots/settings-vocabulary.png (General tab → Custom Vocabulary section, ~1344×1260) -->
16+
![VocaMac Settings showing the Custom Vocabulary editor](/screenshots/settings-vocabulary.png)
17+
18+
## How It Works
19+
20+
Open **Settings → General → Custom Vocabulary** and type the terms you care about, one per line or comma-separated:
21+
22+
```
23+
kubectl, PostgreSQL, nginx, Grafana
24+
```
25+
26+
VocaMac passes these to Whisper as a transcription hint, biasing it toward your spelling. Keep the list focused: the model uses roughly the first 50–100 words, so put your most-mistranscribed terms at the top. There's no training step and no delay. Add a term, and your very next dictation already knows it.
27+
28+
For best results, enter terms in the language you dictate and set a matching transcription language above. In Auto-detect, your vocabulary can even nudge VocaMac toward the right language.
29+
30+
## Private by Design
31+
32+
Your word list never leaves your Mac. Like every other part of VocaMac, custom vocabulary is applied entirely on-device — nothing is uploaded to build or store a dictionary. Your names, projects, and jargon stay yours.

web/content/features/fully-configurable.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ Every major aspect of VocaMac can be customized. Hotkeys, audio behavior, transc
1616

1717
## Hotkey Configuration
1818

19-
Your hotkey is how you activate VocaMac. The app respects your preference for how you work and lets you choose exactly which key combination suits your workflow best.
19+
Your hotkey is how you activate VocaMac. The app respects how you work and lets you pick the single activation key that suits you best.
2020

21-
Maybe you prefer Control-Space. Perhaps Command-Shift-L feels more natural. You might want something completely different. The settings window presents a simple, elegant hotkey selector. Click, press the keys you want to use, and you're done.
21+
Start from a preset — Right Option, Left Option, Right Command, Right Shift, Right Control, Fn, or a function key (F5–F12). Prefer something else? Click **Record**, press any key, and VocaMac captures it (press Escape to cancel). Your choice shows up as a "Custom" key, and while VocaMac is running that key is reserved for activation.
2222

2323
The hotkey works from anywhere on your Mac. Launch VocaMac from Mail, from Slack, from a web browser, or from any application. As long as VocaMac is running, your hotkey is active and ready.
2424

@@ -40,7 +40,7 @@ Set the silence detection threshold to match your environment. In a quiet office
4040

4141
Configure the maximum recording duration. If you prefer shorter bursts of dictation, set a reasonable limit. The app will automatically stop recording when you reach it, preventing accidental marathon recording sessions.
4242

43-
Choose your audio input device. If you use an external microphone, a USB headset, or an AirPods Pro, select it directly from the settings. VocaMac remembers your choice and uses it every time.
43+
Choose your audio input device. Leave it on **System Default** to follow macOS, or pin VocaMac to a specific microphone — an external mic, a USB headset, or AirPods Pro. Pinning is non-invasive: VocaMac uses your chosen device without changing the system-wide default for other apps. If that device disconnects, VocaMac falls back to System Default automatically and resumes using it when the device reconnects. Plugged something in? Hit **Refresh Devices** to update the list.
4444

4545
## Language and Transcription Settings
4646

web/content/features/push-to-talk.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,12 @@ VocaMac supports a wide range of hotkeys for Push-to-Talk activation:
3838
- **Left Option (⌥)** - if you prefer the left side
3939
- **Right Command (⌘)** - for Command-key enthusiasts
4040
- **Right Shift (⇧)** - another good ergonomic choice
41+
- **Right Control (⌃)** - a comfortable reach for many keyboards
4142
- **Function keys (F5-F12)** - if you prefer dedicated keys
4243
- **Fn key** - the function key itself
4344

45+
Want a key that isn't in the list? Click **Record** next to the preset picker and press any key — VocaMac captures it and shows it as your "Custom" key (press Escape to cancel). While VocaMac is running, that key is reserved for activation.
46+
4447
You can change your hotkey anytime in **Settings → General → Activation Key**.
4548

4649
## Visual Feedback
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: "Usage Statistics"
3+
subtitle: "See how much you dictate, how fast you speak, and how consistent you've been. All stored locally."
4+
description: "VocaMac's Stats tab tracks words transcribed, speaking speed, daily streaks, and lifetime totals — stored locally on your Mac and never uploaded."
5+
keywords: "dictation statistics, words per minute tracker, voice typing stats, speaking speed macOS, local usage stats, dictation streak"
6+
icon: "📈"
7+
---
8+
9+
## See How Much You Dictate
10+
11+
Every transcription adds up. The **Stats** tab in Settings turns that into a picture of how you actually use your voice: total words transcribed, number of transcriptions, and total time spoken across the lifetime of the app.
12+
13+
<!-- SCREENSHOT PLACEHOLDER: add web/static/screenshots/settings-stats.png (Stats tab, ~1344×1260, ideally with real usage so it isn't all zeros) -->
14+
![VocaMac Settings showing the Stats tab](/screenshots/settings-stats.png)
15+
16+
## Speed, Streaks, and Recent Activity
17+
18+
- **Speaking speed** — your average words per minute, so you can see how fast you dictate.
19+
- **Daily streak** — consecutive days you've used VocaMac, alongside your best streak so far.
20+
- **Recent activity** — a day-by-day breakdown of words dictated over the last week.
21+
22+
It's a light, motivating way to keep a habit going, without turning dictation into a spreadsheet.
23+
24+
## Private by Design
25+
26+
Your stats are yours alone. They're saved locally on your Mac and never uploaded, synced, or shared — nothing about how much you dictate ever leaves your machine. Want a clean slate? A single button in the Stats tab resets everything.

web/layouts/_default/screenshots.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,11 @@ <h2>⚙️ Settings</h2>
5151
<img src="/screenshots/settings-models.png" alt="VocaMac Settings - Models tab" loading="lazy">
5252
<figcaption>Models - System info, resource usage, and model management</figcaption>
5353
</figure>
54+
<!-- SCREENSHOT PLACEHOLDER: add web/static/screenshots/settings-stats.png (Stats tab, ~1344×1260) -->
55+
<figure class="screenshot-item">
56+
<img src="/screenshots/settings-stats.png" alt="VocaMac Settings - Stats tab" loading="lazy">
57+
<figcaption>Stats - Lifetime totals, speaking speed, and daily streaks</figcaption>
58+
</figure>
5459
<figure class="screenshot-item">
5560
<img src="/screenshots/settings-audio.png" alt="VocaMac Settings - Audio tab" loading="lazy">
5661
<figcaption>Audio - Recording duration, silence detection, and input device</figcaption>

web/layouts/index.html

Lines changed: 26 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,9 @@
3232
"Launch at Login",
3333
"Clipboard preservation",
3434
"Cursor indicator overlay",
35+
"Custom vocabulary for names and jargon",
36+
"Local usage statistics (streaks, WPM, lifetime totals)",
37+
"Selectable audio input device",
3538
"Guided setup wizard",
3639
"Open source (AGPL-3.0 license)"
3740
],
@@ -180,62 +183,72 @@ <h2>Everything You Need,<br>Nothing You Don't</h2>
180183
<a href="/features/system-wide-text-injection/" class="feature-card">
181184
<div class="feature-card__icon">⌨️</div>
182185
<h3>System-Wide Text Injection</h3>
183-
<p>Transcribed text appears wherever your cursor is. Browsers, Slack, VS Code, spreadsheets, terminals. Everywhere.</p>
186+
<p>Transcribed text appears at your cursor, in any app.</p>
184187
</a>
185188
<a href="/features/push-to-talk/" class="feature-card">
186189
<div class="feature-card__icon">🎯</div>
187190
<h3>Push-to-Talk</h3>
188-
<p>Hold a hotkey to record. Release to transcribe. Simple, predictable, no surprises.</p>
191+
<p>Hold a hotkey to record, release to transcribe.</p>
189192
</a>
190193
<a href="/features/double-tap-toggle/" class="feature-card">
191194
<div class="feature-card__icon">👆</div>
192195
<h3>Double-Tap Toggle</h3>
193-
<p>Prefer toggle mode? Double-tap to start, double-tap to stop. Your choice.</p>
196+
<p>Double-tap to start, double-tap to stop.</p>
194197
</a>
195198
<a href="/features/smart-model-selection/" class="feature-card">
196199
<div class="feature-card__icon">🧠</div>
197200
<h3>Smart Model Selection</h3>
198-
<p>Auto-detects your Apple Silicon chip and RAM, then recommends the optimal Whisper model.</p>
201+
<p>Auto-picks the best Whisper model for your Mac.</p>
199202
</a>
200203
<a href="/features/apple-silicon-native/" class="feature-card">
201204
<div class="feature-card__icon"></div>
202205
<h3>Apple Silicon Native</h3>
203-
<p>CoreML + Metal + Neural Engine acceleration via WhisperKit. Blazing fast on M1/M2/M3/M4.</p>
206+
<p>CoreML + Neural Engine speed via WhisperKit.</p>
204207
</a>
205208
<a href="/features/fully-configurable/" class="feature-card">
206209
<div class="feature-card__icon">⚙️</div>
207210
<h3>Fully Configurable</h3>
208-
<p>Choose hotkeys, models, languages, silence detection. Settings window with model management.</p>
211+
<p>Tune hotkeys, models, languages, and silence detection.</p>
209212
</a>
210213
<a href="/features/languages/" class="feature-card">
211214
<div class="feature-card__icon">🌍</div>
212215
<h3>99+ Languages</h3>
213-
<p>Auto-detect or specify. English, Spanish, French, German, Chinese, Japanese, and many more.</p>
216+
<p>Auto-detect or pick your language — 99+ supported.</p>
214217
</a>
215218
<a href="/features/visual-feedback/" class="feature-card">
216219
<div class="feature-card__icon">📊</div>
217220
<h3>Visual Feedback</h3>
218-
<p>Menu bar icon changes color. Audio level indicator shows input. Cursor indicator near your caret while recording.</p>
221+
<p>Color cues and a live audio meter while recording.</p>
219222
</a>
220223
<a href="/features/translation/" class="feature-card">
221224
<div class="feature-card__icon">🌐</div>
222225
<h3>Translation</h3>
223-
<p>Speak in one language, get text in another. Built-in speech translation powered by Whisper.</p>
226+
<p>Speak one language, get text in another.</p>
227+
</a>
228+
<a href="/features/custom-vocabulary/" class="feature-card">
229+
<div class="feature-card__icon">📝</div>
230+
<h3>Custom Vocabulary</h3>
231+
<p>Teach it your names, jargon, and acronyms.</p>
224232
</a>
225233
<a href="/features/silence-detection/" class="feature-card">
226234
<div class="feature-card__icon">🤫</div>
227235
<h3>Silence Detection</h3>
228-
<p>Auto-stops recording after you stop speaking. Adjustable sensitivity and duration thresholds.</p>
236+
<p>Auto-stops when you stop speaking. Fully adjustable.</p>
229237
</a>
230238
<a href="/features/launch-at-login/" class="feature-card">
231239
<div class="feature-card__icon">🚀</div>
232240
<h3>Launch at Login</h3>
233-
<p>Start VocaMac automatically when you log in. Always ready when you need it.</p>
241+
<p>Starts automatically at login. Always ready.</p>
234242
</a>
235243
<a href="/features/clipboard-preservation/" class="feature-card">
236244
<div class="feature-card__icon">📋</div>
237245
<h3>Clipboard Preservation</h3>
238-
<p>Your clipboard is saved and restored after text injection. Nothing gets overwritten.</p>
246+
<p>Saved and restored after every injection.</p>
247+
</a>
248+
<a href="/features/usage-stats/" class="feature-card">
249+
<div class="feature-card__icon">📈</div>
250+
<h3>Usage Statistics</h3>
251+
<p>Track words, speaking speed, and daily streaks.</p>
239252
</a>
240253
</div>
241254
</div>
@@ -606,7 +619,7 @@ <h2>Questions & Answers</h2>
606619
</details>
607620
<details class="faq__item">
608621
<summary>Can I change the hotkey?</summary>
609-
<p>Yes! Open Settings from the menu bar and choose from Right Option, Right Command, Fn, or any function key. You can also switch between push-to-talk and double-tap toggle modes.</p>
622+
<p>Yes! Open Settings from the menu bar and pick a preset (Right Option, Right Command, Right Control, Fn, or a function key), or click <strong>Record</strong> and press any key to set a custom one. You can also switch between push-to-talk and double-tap toggle modes.</p>
610623
</details>
611624
<details class="faq__item">
612625
<summary>How does this compare to Apple's built-in dictation?</summary>

web/layouts/partials/head.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
<meta name="theme-color" content="#FFFFFF">
3939

4040
<!-- Open Graph -->
41-
<meta property="og:type" content="website">
41+
<meta property="og:type" content="{{ if .IsHome }}website{{ else }}article{{ end }}">
4242
<meta property="og:url" content="{{ .Permalink }}">
4343
<meta property="og:title" content="{{ if .IsHome }}VocaMac - 100% Local Voice-to-Text for macOS{{ else }}{{ .Title }} | VocaMac{{ end }}">
4444
<meta property="og:description" content="{{ with .Params.description }}{{ . }}{{ else }}{{ .Site.Params.description }}{{ end }}">
59.1 KB
Loading

0 commit comments

Comments
 (0)