# Read Frog


- **Get Started**
- [Introduction](/en/docs): Read Frog translates what you are reading, then turns the parts worth keeping into study material.
- [Installation](/en/docs/installation): Install Read Frog, pick a provider, and translate your first page.
- [Account and Plans](/en/docs/account-and-plans): What signing in adds, how the built-in AI allowance works, and which features a paid plan unlocks.

- **Translating**
- Page Translation
  - [Page and Paragraph Translation](/en/docs/page-translation): Translate a full page or a single paragraph, then choose the reading mode that works for you.
  - [Hover Translation](/en/docs/page-translation/hover-translation): Translate the one paragraph under your pointer by holding a key, and put it back the same way.
  - [Translation Control](/en/docs/page-translation/translation-control): What starts translating on its own, what never does, and which paragraphs get skipped once it has started.
  - [Custom Translation Styles](/en/docs/page-translation/style): Configure custom CSS to personalize your translation appearance
  - Prompts
    - [Custom Prompts](/en/docs/page-translation/prompts): The two pieces of text Read Frog sends to the model, where to edit them, and what breaks if you remove a placeholder.
    - [Prompt Variables](/en/docs/page-translation/prompts/variables): Every variable a Read Frog prompt can use, with the actual value each one is replaced by.
    - [How a Request Is Assembled](/en/docs/page-translation/prompts/pipeline): The order in which Read Frog builds the prompt it sends, and what it does with the text the model sends back.
- Video Subtitles
  - [Video Subtitles](/en/docs/video-subtitles): Translate YouTube captions, including Shorts and embedded players, with independent display, provider, prompt, rate, and batch settings.
  - [Custom Subtitle Styles](/en/docs/video-subtitles/style): Write your own CSS for video subtitles — blur the translation, dim the original, or restyle the caption box.
  - [Subtitle Prompts](/en/docs/video-subtitles/prompts): Subtitles have their own prompt list, with a video summary in place of the page content variables.
  - [AI Segmentation & Quota](/en/docs/video-subtitles/ai-segmentation): Two separate AI features on the Video Subtitles screen — re-cutting caption lines into sentences, and generating subtitles for a video that has none.
- [Selection Translation](/en/docs/selection-translation): Translate the text you have selected. The result streams into a panel beside the selection, and the page itself is left alone.
- [Input Translation](/en/docs/input-translation): Write a message in your own language, tap the space bar three times, and have the text box hold the translation instead.
- [Translation Hub](/en/docs/translation-hub): Paste text once and translate it with several providers side by side, so you can compare wording before committing to one.
- [Entry Points](/en/docs/entry-points): The floating button, the selection toolbar, and the browser context menu — the three places Read Frog can be reached from while you are reading.
- [Glossary](/en/docs/glossary): Give the terms that matter to you a fixed translation, keep names untouched, and choose which websites each list applies to.
- [Translate Local Web Pages](/en/docs/local-files): Allow Read Frog to access file URLs and translate local HTML files in Chrome or Edge.

- **Learning**
- [How Learning Works](/en/docs/learning): The path from a word you selected while reading to a card that comes back on a schedule.
- [Custom AI Actions](/en/docs/custom-actions): Create reusable AI actions for selected text, such as dictionary lookup, rewriting, summaries, and structured reading
- Notebase
  - [Notebases, Fields, Notes and Cards](/en/docs/notebase): The four pieces the learning side is built from, and how a saved lookup becomes something you review.
  - [Create a Notebase](/en/docs/notebase/create): Make a notebase on readfrog.app and define the fields your saved lookups will land in.
  - [Save from the Extension](/en/docs/notebase/save-from-extension): Connect a Custom AI Action to a notebase, map its output fields, and save results from the selection toolbar.
  - [Card Templates](/en/docs/notebase/card-templates): Turn a notebase's fields into a card front and a card back, and watch the result before you save.
  - [Manage Notes and Fields](/en/docs/notebase/manage): The table view, editing notes, and exactly what deleting a field, a note or a notebase takes with it.
- Review
  - [The Review Session](/en/docs/review): What a card looks like, how the four grade buttons differ, and what the counts in the header are telling you.
  - [Study Settings](/en/docs/review/study-settings): Daily limits and target retention, set for each notebase, plus the day boundary the whole schedule is measured against.
  - [How Scheduling Works](/en/docs/review/scheduling): Why one card comes back tomorrow and another in eight months, and what the optimizer learns from your own review history.
- [Statistics](/en/docs/statistics): Read the activity heatmap, the growth charts, and a single card's forgetting curve.
- MCP
  - [MCP](/en/docs/mcp): Let an AI assistant read and write your own notebases, notes, card templates and review history over a remote MCP connection.
  - [Connect an assistant](/en/docs/mcp/connect): Add the MCP server to your AI client, choose what it may reach among the five permission groups, and revoke it when you are done.
  - [Recipes](/en/docs/mcp/recipes): Things worth asking an assistant to do with your notes and cards, each with the prompt to type, the tools it uses, and the permission it needs.
  - [Tool reference](/en/docs/mcp/reference): All 29 MCP tools grouped by permission, with what each one does and what it requires.

- **Configuration**
- Model Providers
  - [Set Up Providers and API Keys](/en/docs/providers/overview): Add a translation or LLM provider, choose a model when needed, and verify the connection before reading.
  - [Built-in Provider Configuration](/en/docs/providers/built-in-providers): Add a supported translation or LLM provider and assign it only to compatible Read Frog features.
  - [OpenAI-Compatible Custom Providers](/en/docs/providers/openai-compatible-providers): Connect a provider or self-hosted service that exposes an OpenAI-compatible API.
  - [Pure Translation Providers](/en/docs/providers/pure-translation-providers): What a pure translation provider is, which ones Read Frog supports, what each one needs, and when to choose one over an LLM provider.
  - [DeepLX](/en/docs/providers/deeplx): DeepLX is a free translation API that provides DeepL-like translation quality. Learn how to configure different DeepLX providers with flexible baseURL patterns.
  - [DeepL](/en/docs/providers/deepl): Configure the official DeepL API in Read Frog. Learn how Free and Pro keys are detected automatically, what fields to fill in, and how to troubleshoot common errors.
  - [Ollama](/en/docs/providers/ollama): Read Frog can leverage a locally deployed Ollama server to achieve offline AI translation capabilities，completely free to use powerful large language AI models
  - [LM Studio](/en/docs/providers/lm-studio): Use local OpenAI-compatible LLMs in Read Frog through LM Studio Local Server
- [Text to Speech](/en/docs/tts): Configure Edge TTS voices by language and tune speaking rate, pitch, and volume for Read Frog tools.
- [Shortcuts](/en/docs/shortcuts): Every key Read Frog listens for while you read, what it does, and how to record your own.
- [Site Control](/en/docs/site-control): Decide which websites Read Frog is allowed to run on at all, with a blacklist you add exceptions to or a whitelist you opt sites into.
- [Configuration, Sync & Backups](/en/docs/config-backup): Safely export, import, sync, back up, restore, reset, and localize Read Frog settings.

- **Advanced**
- [Request Control & Batch Translation](/en/docs/request-control): Understand Read Frog's Token Bucket, burst requests, LLM batching, retries, fallback, and conservative settings for low-quota APIs.
- [Site Control & Site Rules](/en/docs/site-rules): Decide where Read Frog runs and safely customize matching, selectors, layout, thresholds, and CSS with per-site JSON rules.
- [Privacy and Your Data](/en/docs/privacy-and-data): What stays in your browser, what is sent to a provider, and what Read Frog itself receives.
- [Troubleshooting](/en/docs/troubleshooting): Start from the symptom and find the setting that causes it.

- **Contributing**
- [Contribution Guide](/en/docs/contributing): Let's build a better language learning product together