概要

Translation Settings

Publish your documentation in multiple languages — automatically, with no manual work.

Settings#

Setting What it does
Enabled languages Which languages to publish your docs in
Language switcher in sidebar Show the language selector in the left sidebar
Language selector in header Show the language selector in the top header bar

How to Enable#

  1. Requires a Pro plan.
  2. Open your docs site.
  3. Float Widget → Translation tab.
  4. Check the languages you want to enable.
  5. Save — translation starts automatically in the background.

Translation typically takes 1–5 minutes for small repositories, up to 30 minutes for large ones.

Supported Languages#

15 core languages are available:

Language Code
Spanish es
French fr
German de
Portuguese pt
Italian it
Russian ru
Chinese zh
Japanese ja
Korean ko
Arabic ar
Hindi hi
Turkish tr
Polish pl
Dutch nl
English en (default)

Language Switcher Placement#

The language switcher can appear in the sidebar, the header, or both.

Recommendation: Pick one location. Showing it in both places is redundant.

Placement Best for
Header More visible, better for international audiences
Sidebar Saves header space when header is already full

Configure placement in:

URL Structure#

Each language gets its own URL path:

docsbook.io/{username}/{repo}           → English (default)
docsbook.io/{username}/es/{repo}        → Spanish
docsbook.io/{username}/fr/{repo}        → French

Each language version is indexed separately by search engines, which means passive SEO traffic in every language you publish.

Keeping Translations Current#

The Translation Activity panel, on the same Translation tab, is where you check and fix the state of your translations.

It shows:

  • Coverage for each language — of every page in your docs, how many are translated and current, how many are behind your source, and how many have no translation at all. Untranslated pages are the ones your readers see in the original language, so they are counted first.
  • How many pages are behind your source. Compared against the current content in your repository, not against a label — so it reflects what your readers are actually being served.
  • Orphaned translations whose source file was renamed or deleted.
  • A live progress bar while a translation run is going, and, if a run stopped early, why it stopped (budget spent or provider quota reached).
  • What translation cost, next to how many sections were reused from cache instead of re-translated.

From the same panel you can:

  • Fill in what's missing — the button on each language row translates only the pages that are missing or behind. Pages already up to date are skipped and cost you nothing.
  • Re-translate a language from scratch — offered once a language is fully covered, for when the translations themselves need redoing.
  • Re-translate a single page — from Redo in the recent-changes list.

Re-translating is how a page that has fallen behind gets caught up. Editing a page in GitHub does not re-translate it by itself.

Disabling a Language#

Uncheck the language in the Translation tab → Save.

Visitors on that language's URL are automatically redirected to the English version. Cached translations are kept — re-enabling is instant.


Reach a global audience without hiring translators. Upgrade to Pro →

See also: How AI Translations work →

Updated