pronounce-button
GitHub根据用户请求,调用 ElevenLabs TTS API 生成术语的 MP3 发音文件,并在 Markdown 文件中插入对应的播放按钮。支持三级回退策略以优化发音准确度。
Trigger Scenarios
Install
npx skills add dmccreary/ibook-skills --skill pronounce-button -g -y
SKILL.md
Frontmatter
{
"name": "pronounce-button",
"description": "Generate an MP3 pronunciation of a glossary term using ElevenLabs TTS API and insert a \"Pronounce\" button into the term's entry in a markdown file. Trigger when the user says \"Create a pronounce button for the term X\" or \"Add pronunciation for X\". Defaults to glossary.md if no file is specified."
}
Pronounce Button Skill
Add an inline audio "Pronounce" button to a glossary term or any term heading in a markdown file, powered by ElevenLabs text-to-speech.
When to Use
Trigger this skill when the user asks to:
- "Create a pronounce button for the term 'Bryophytes'"
- "Create a pronounce button for the term 'Bryophytes' in glossary.md"
- "Add pronunciation for 'Sphagnum Moss'"
- "Add a pronounce button for X in chapter-03.md"
Prerequisites
- The environment variable
ELEVENLABS_API_KEYmust be set. Never hard-code or commit this key. - The ElevenLabs API reference repo is at
/Users/dan/Documents/ws/elevenlabs-skillsfor additional documentation if needed.
Workflow
Step 1: Identify the Term and Target File
Parse the user's request to extract:
- Term — the word or phrase to pronounce (e.g., "Bryophytes")
- Target file — the markdown file containing the term (default:
docs/glossary.md)
Step 2: Generate the MP3
Important: Try the plain word first. ElevenLabs handles most scientific terms correctly when given the actual word. Only fall back to phonetic spelling if the plain word sounds wrong after listening to it.
Three-tier approach (escalate only when the user reports a problem):
-
Tier 1 — Plain word (default). Send the actual term (e.g.,
"Biogeography"). This works for most words. Always try this first. -
Tier 2 — Hyphenated phonetic (fallback). If the user says the plain word sounds wrong, regenerate using a hyphenated phonetic version (e.g.,
"Gah-mee-toh-fyte"). This can backfire — ElevenLabs sometimes reads each syllable as a separate word — so only use when Tier 1 fails. -
Tier 3 — SSML with CMU Arpabet (last resort). If both plain and phonetic versions fail, use the
--ssmlflag with a CMU Arpabet string. This switches toeleven_flash_v2which supports SSML<phoneme>tags for precise phoneme-level control. Only use when the user explicitly indicates that Tiers 1 and 2 both failed.
Tier 1 — Plain word:
python3 SCRIPT "Biogeography" --output docs/audio/biogeography.mp3
Tier 2 — Phonetic fallback:
python3 SCRIPT "Gah-mee-toh-fyte" --output docs/audio/gametophyte.mp3
Tier 3 — SSML (last resort):
python3 SCRIPT "evapotranspiration" \
--ssml "IH0 V AE2 P OW0 T R AE2 N S P ER0 EY1 SH AH0 N" \
--output docs/audio/evapotranspiration.mp3
The --ssml flag takes a CMU Arpabet phoneme string. Stress markers are
required: 1 = primary stress, 2 = secondary stress, 0 = no stress.
See CMU Arpabet reference for
the full phoneme set.
Known terms that required SSML (user-verified):
| Term | CMU Arpabet |
|---|---|
| Acrocarpous | AE2 K R OW0 K AA1 R P AH0 S |
| Evapotranspiration | IH0 V AE2 P OW0 T R AE2 N S P ER0 EY1 SH AH0 N |
Where SCRIPT is:
python3 /Users/dan/.claude/skills/pronounce-button/scripts/generate-pronunciation.py
Where SLUG is the term lowercased with spaces replaced by hyphens
(e.g., "Sphagnum Moss" → sphagnum-moss).
The script:
- Reads
ELEVENLABS_API_KEYfrom the environment - Calls the ElevenLabs v1 TTS endpoint with the
eleven_multilingual_v2model - Writes an MP3 file to
docs/audio/SLUG.mp3 - Uses the "Sarah" voice by default (clear US female voice suitable for term pronunciation)
If the API call fails, report the error to the user. Common issues:
- 401: Invalid API key — ask the user to check
ELEVENLABS_API_KEY - 429: Rate limit — wait and retry
Step 3: Insert the Pronounce Button
Locate the term heading in the target markdown file. The heading format is
typically #### Term Name in the glossary, but may be other heading levels
in chapter files.
Insert the pronounce button HTML immediately after the heading line, before the definition text. Use this exact HTML pattern:
<audio id="audio-SLUG" src="../audio/SLUG.mp3" preload="none"></audio>
<button onclick="document.getElementById('audio-SLUG').play()" class="pronounce-btn">🔊 Pronounce</button> *PHONETIC-GUIDE*
The phonetic guide uses italics with the stressed syllable in ALL CAPS
(e.g., *gah-MEE-toh-fyte*). Always include this next to the button so
users can verify the pronunciation visually.
Adjust the relative path (src attribute) based on the target file's
location relative to docs/audio/. MkDocs uses directory URLs by default,
so each page is served from a subdirectory (e.g., glossary.md becomes
glossary/index.html). Count directory levels from the page's served URL
back to the site root, then append audio/SLUG.mp3. For example:
| Target file | Served URL path | Relative path |
|---|---|---|
docs/glossary.md |
/glossary/ |
../audio/SLUG.mp3 |
docs/appendices/common-terms.md |
/appendices/common-terms/ |
../../audio/SLUG.mp3 |
docs/chapters/03-what-is-moss/index.md |
/chapters/03-what-is-moss/ |
../../audio/SLUG.mp3 |
Example result in glossary.md:
#### Bryophytes
<audio id="audio-bryophytes" src="../audio/bryophytes.mp3" preload="none"></audio>
<button onclick="document.getElementById('audio-bryophytes').play()" class="pronounce-btn">🔊 Pronounce</button> *BRY-oh-fytes*
A division of non-vascular land plants that includes mosses, liverworts,
and hornworts, all of which reproduce via spores and lack true roots,
stems, or leaves.
Step 4: Ensure CSS Exists
Check if docs/stylesheets/extra.css (or whatever custom CSS file is
referenced in mkdocs.yml) contains a .pronounce-btn style. If not,
append the following:
/* Pronounce button for glossary terms */
.pronounce-btn {
background: #e8f5e9;
border: 1px solid #4caf50;
border-radius: 4px;
padding: 2px 10px;
font-size: 0.85em;
cursor: pointer;
margin-bottom: 8px;
display: inline-block;
}
.pronounce-btn:hover {
background: #c8e6c9;
}
Step 5: Confirm to User
Report success with the local preview URL:
Generated pronunciation for "Bryophytes" → docs/audio/bryophytes.mp3
Added Pronounce button to docs/glossary.md
Preview: http://127.0.0.1:8000/moss/glossary/#bryophytes
Voice Options
The default voice is Sarah (EXAVITQu4vr4xnSDxMaL) — a clear US female
voice well-suited for academic term pronunciation. If the user requests a
different voice, pass --voice-id to the script. Common alternatives:
| Voice | ID | Style |
|---|---|---|
| Sarah (default) | EXAVITQu4vr4xnSDxMaL | Female, soft |
| Charlotte | XB0fDUnXU5powFXDhCwa | Female, conversational |
| George | JBFqnCBsd6RMkjVDRZzb | Male, narrative |
| Daniel | onwK4e9ZLuTAKqWW03F9 | Male, authoritative |
Batch Mode
To add pronounce buttons for multiple terms at once, the user may say "Add pronounce buttons for all terms in the glossary." In this case:
- Read
docs/glossary.mdand extract all####headings - For each term, run the script and insert the button
- Report the total count when done
Important: Batch mode makes one API call per term. Warn the user about the number of API calls before proceeding (e.g., "This will make 400 API calls to ElevenLabs. Proceed?").
Version History
- fa205dc Current 2026-08-20 09:00


