Intlayer Documentation

Welcome to the official Intlayer documentation! Here, you'll find everything you need to integrate, configure, and master Intlayer for all your internationalization (i18n) needs, whether you’re working with Next.js, React, Vite, Express, or another JavaScript environment.

Intlayer offers a flexible, modern approach to translating your application. Our docs will guide you from installation and setup through advanced features like AI-powered translation, TypeScript definitions, and server component support, empowering you to create a seamless, multilingual experience.

Getting Started

• Introduction
  Get an overview of how Intlayer works, its core features, and why it’s a game-changer for i18n.

• How Intlayer Works
  Dive into the architectural design and learn how Intlayer handles everything from content declaration to translation delivery.

• Configuration
  Customize Intlayer to suit your project’s needs. Explore middleware options, directory structures, and advanced settings.

• Intlayer CLI
  Manage content and translations using our command-line tool. Discover how to push and pull content, automate translations, and more.

• Intlayer Editor
  Simplify collaboration with non-developers and power your translations with AI, directly in our free, intuitive CMS.

Core Concepts

Dictionary

Organize your multilingual content close to your code to keep everything consistent and maintainable.

• Get Started
  Learn the basics of declaring your content in Intlayer.

• Translation
  Understand how translations are generated, stored, and utilized in your application.

• Enumeration
  Easily manage repeated or fixed sets of data across various languages.

• Condition
  Learn how to use conditional logic in Intlayer to create dynamic content.

• Insertion Discover how to insert values in a string using insertion placeholders.

• Function Fetching
  See how to dynamically fetch content with custom logic to match your project’s workflow.

• Markdown
  Learn how to use Markdown in Intlayer to create rich content.

• File embeddings
  Discover how to embed externals files in Intlayer to use them in the content editor.

• Nesting
  Understand how to nest content in Intlayer to create complex structures.

Environments & Integrations

We’ve built Intlayer with flexibility in mind, offering seamless integration across popular frameworks and build tools:

• Intlayer with Next.js 15
• Intlayer with Next.js 14 (App Router)
• Intlayer with Next.js Page Router
• Intlayer with React CRA
• Intlayer with Vite + React
• Intlayer with React Native and Expo
• Intlayer with Lynx and React
• Intlayer with Express

Each integration guide includes best practices for using Intlayer’s features, like server-side rendering, dynamic routing, or client-side rendering, so you can maintain a fast, SEO-friendly, and highly scalable application.

Packages

Intlayer’s modular design offers dedicated packages for specific environments and needs:

intlayer

Core utility functions to configure and manage your i18n setup.

• getConfiguration
• getHTMLTextDir
• getLocaleLang
• getLocaleName
• getLocalizedUrl
• getMultilingualUrls
• getPathWithoutLocale
• getTranslation
• getEnumeration

express-intlayer

Leverage Intlayer within Express-based apps:

• t
  A minimal, straightforward translation helper for your server routes and views.

react-intlayer

Enhance your React applications with powerful hooks:

• t
• useIntlayer
• useDictionary
• useLocale

next-intlayer

Seamlessly integrate with Next.js:

• t
• useIntlayer
• useDictionary
• useLocale

Additional Resources

• Blog: Intlayer and i18next
  Learn how Intlayer complements and compares with the popular i18next library.

• Live Tutorial on YouTube
  Watch a comprehensive demo and learn how to integrate Intlayer in real-time.

Contributing & Feedback

We value the power of open-source and community-driven development. If you’d like to propose improvements, add a new guide, or correct any issues in our docs, feel free to submit a Pull Request or open an issue on our GitHub repository.

Ready to translate your application faster and more efficiently? Dive into our docs to start using Intlayer today. Experience a robust, streamlined approach to internationalization that keeps your content organized and your team more productive.

Doc History