Skip to content

Integrations ​

Reference for the framework integrations: what they share and how their shell strings differ. To add languages to a site, start at Add i18n to a website or docs site. For an app, start at Add i18n to a JS/TS app, Add i18n to a Python app, or Add i18n to a .NET app. For a repository README and other Markdown files, start at Add i18n to your README and Markdown docs.

Documentation integrations use the Documents pipeline (translate-docs / sync) for page content; shell strings (nav, sidebar, theme) are handled inside that same pipeline where noted — not via the separate JSON pipeline. Python applications use the UI strings pipeline (extract / translate-ui).

Which guide to read ​

The chooser table, with one init template per framework, is in Add i18n to a website or docs site. The walkthrough prompt on that page enables the framework's i18n. The integration pages below keep the shell-catalog details. Python frameworks: Python.

Shared concepts ​

Documentation-framework integrations share the same docs[] block model described in Documents. Set docsOutput.style to match your framework ("docusaurus", "vitepress", "nextra", "fumadocs", or "astro-starlight"). For output folder layout and link rewriting behaviour, see Output layouts and Link rewriting. Python setup is separate: Python.

Each init -t ui-* -P <provider> scaffold writes that preset's LLM provider block. Before translate-docs or sync, set the matching API key — see Provider and API key.

See Framework shell translation for a cross-framework comparison. Each linked guide below covers setup for that framework.

Framework shell translation ​

FrameworkShell / theme stringsPipeline
Docusauruswrite-translations catalog ({ message, description })Documents — docs[].docusaurusCatalogDir + translate-docs
VitePressTheme/nav/sidebar catalogDocuments — docsOutput.vitepressThemeCatalog + translate-docs
Nextra_meta.ts sidebar labelsDocuments — auto when style: "nextra" + translate-docs
NextraTheme dictionary .tsDocuments — docs[].nextraDictionaryPath + translate-docs
Fumadocsmeta.json sidebar labelsDocuments — auto when style: "fumadocs" + translate-docs
FumadocsUI overrides catalogDocuments — docsOutput.fumadocsUiCatalog + translate-docs
Astro StarlightBuilt-in UI strings (many locales); no additional shell pipelineDocuments — translate-docs (pages only)

Do not put framework shell/theme strings in json[] — that pipeline is for unrelated app locale bundles. Per-framework setup details are in the guides linked from Which guide to read.

Runnable examples ​

FrameworkExample repo
Astro Starlightexamples/astro-docs
Plain Astro websiteexamples/astro-website
Docusaurusexamples/docusaurus-docs
VitePressexamples/vitepress-docs
Nextraexamples/nextra-docs
Fumadocsexamples/fumadocs-docs
Streamlitexamples/python-streamlit
Flaskexamples/python-flask
FastAPIexamples/python-fastapi
GNU gettextexamples/python-gettext
.NET JSON helperexamples/dotnet-console
.NET ResourceManager helperexamples/dotnet-resx

Released under the MIT License.