Skip to content
Tyndale

Installation

Prerequisites

Section titled “Prerequisites”
  • Node.js 20 or later
  • React 18.2+ or 19+ for React/Next.js/Astro app translation
  • An AI provider API key (Anthropic, OpenAI, etc.)

Supported frameworks

Section titled “Supported frameworks”

App translation (tyndale extract / tyndale translate)

Section titled “App translation (tyndale extract / tyndale translate)”
  • React
  • Vite + React
  • Next.js
  • Astro components (.astro)

Documentation translation (tyndale translate-docs)

Section titled “Documentation translation (tyndale translate-docs)”
  • Starlight
  • Docusaurus
  • VitePress
  • MkDocs
  • Nextra

Install packages

Section titled “Install packages”
Terminal window
npm install tyndale-react
npm install -D tyndale

For Next.js projects, also install the adapter:

Terminal window
npm install tyndale-next

For Astro app translation, add Astro’s React integration if your project does not already render React components:

Terminal window
npx astro add react

Tyndale translates .astro application files through the normal extract / translate flow. Use translate-docs separately when you want to translate Starlight or other docs sites.

Initialize your project

Section titled “Initialize your project”
Terminal window
npx tyndale init

This creates a tyndale.config.json at your project root with sensible defaults, including .astro in extensions.

Framework-specific guides

Section titled “Framework-specific guides”