Skip to main content

Text-to-Speech Feature 🔊

This documentation site includes a built-in text-to-speech (TTS) feature to make content more accessible and convenient for all users.

How to Use​

Floating TTS Button​

Look for the 🔊 floating button in the bottom-right corner of documentation pages. Click it to start listening to the current page content.

Keyboard Shortcuts​

  • Alt + S: Start/Stop audio playback
  • Alt + P: Pause/Resume playback
  • Alt + X: Stop playback completely

TTS Controls​

When the TTS panel is expanded, you can adjust:

  • Voice: Choose from available system voices
  • Speed: Adjust playback speed (0.5x to 2x)
  • Pitch: Modify voice pitch for comfort

Browser Support​

Text-to-speech works in modern browsers that support the Web Speech API:

  • ✅ Chrome/Chromium (recommended)
  • ✅ Edge
  • ✅ Safari (macOS/iOS)
  • ⚠️ Firefox (limited voice selection)

Accessibility Features​

Screen Reader Friendly​

  • All TTS controls have proper ARIA labels
  • Keyboard navigation supported
  • Focus indicators for better visibility

Customizable Experience​

  • Adjustable playback speed for different needs
  • Voice selection for language preferences
  • Compact mode for minimal interface

High Contrast Support​

The TTS interface adapts to high contrast mode preferences automatically.

Troubleshooting​

No Audio​

  • Check browser TTS support
  • Enable system audio/volume
  • Try different voices in settings

Poor Quality​

  • Switch to higher quality system voices
  • Adjust speed/pitch settings
  • Use Chrome for best experience

Not Loading​

  • Refresh the page
  • Check JavaScript is enabled
  • Verify browser compatibility

Privacy & Security​

  • No data collection: All TTS processing happens locally
  • No external APIs: Uses browser's built-in speech synthesis
  • Offline capable: Works without internet connection
  • No tracking: No usage analytics collected

This feature enhances accessibility and user experience across our documentation. For questions or feedback, please reach out to our team.