Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions android-sdk/about.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ id: about
title: Overview
slug: /
description: Overview of Tolgee Android SDK with Over‑the‑Air (OTA) localization updates and how to get started.
image: /img/og-images/android-sdk.png
---

> NOTE:
Expand Down
1 change: 1 addition & 0 deletions android-sdk/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: installation
title: Installation
description: How to install Tolgee Android SDK in your Android project
image: /img/og-images/android-sdk.png
---

> **NOTE:**
Expand Down
1 change: 1 addition & 0 deletions android-sdk/jetpack/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: installation
title: Installation
description: How to install Tolgee Android SDK in your Android project with Jetpack Compose support
image: /img/og-images/android-sdk.png
---

> **NOTE:**
Expand Down
1 change: 1 addition & 0 deletions android-sdk/jetpack/troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: troubleshooting
title: Troubleshooting
description: Troubleshooting Tolgee Android SDK for Jetpack Compose
image: /img/og-images/android-sdk.png
---

## Translations Not Updating
Expand Down
1 change: 1 addition & 0 deletions android-sdk/jetpack/usage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: usage
title: Usage
description: How to use Tolgee Android SDK in your Android application with Jetpack Compose support
image: /img/og-images/android-sdk.png
---

> Prerequisite: Make sure you’ve installed and initialized the Tolgee for Compose. See: [Jetpack Compose Installation](./installation.mdx)
Expand Down
1 change: 1 addition & 0 deletions android-sdk/modules.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: modules
title: Modules overview
description: Choose between Core and Compose based on your app architecture.
image: /img/og-images/android-sdk.png
---

Tolgee Android SDK is split into modules so you only add what you need.
Expand Down
1 change: 1 addition & 0 deletions android-sdk/production.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: production
title: Production guide
description: OTA updates, caching, formatting, and deployment tips for shipping to production.
image: /img/og-images/android-sdk.png
---

This guide summarizes recommendations for using Tolgee Android SDK in production.
Expand Down
1 change: 1 addition & 0 deletions android-sdk/troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: troubleshooting
title: Troubleshooting
description: Troubleshooting Tolgee Android SDK
image: /img/og-images/android-sdk.png
---

## Translations Not Loading
Expand Down
1 change: 1 addition & 0 deletions android-sdk/usage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: usage
title: Usage
description: How to use Tolgee Android SDK in your Android application
image: /img/og-images/android-sdk.png
---

## Quickstart
Expand Down
8 changes: 8 additions & 0 deletions docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,20 @@ const config: Config = {
markdown: {
hooks: {
onBrokenMarkdownLinks: 'warn',
onBrokenMarkdownImages: 'warn',
},
},
organizationName: 'Tolgee',
projectName: 'Tolgee',
themes: ['docusaurus-theme-openapi-docs'],
themeConfig: {
image: '/img/og-images/homepage.png',
metadata: [
{ property: 'og:type', content: 'website' },
{ property: 'og:image:width', content: '1200' },
{ property: 'og:image:height', content: '630' },
{ name: 'twitter:card', content: 'summary_large_image' },
],
navbar,
footer,
algolia: {
Expand Down
1 change: 1 addition & 0 deletions ios-sdk/about.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ id: about
title: Tolgee iOS SDK Overview
slug: /
description: Overview of Tolgee iOS SDK with Over‑the‑Air (OTA) localization updates and how to get started.
image: /img/og-images/ios-sdk.png
---

> NOTE:
Expand Down
1 change: 1 addition & 0 deletions ios-sdk/advanced.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: advanced
title: Advanced usage
description: Tips and tricks for debugging and using the SDK with advanced codebases.
image: /img/og-images/ios-sdk.png
---

### Custom tables/namespaces
Expand Down
1 change: 1 addition & 0 deletions ios-sdk/get_started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: get_started
title: Get started
description: How to install Tolgee iOS SDK and basic usage instructions.
image: /img/og-images/ios-sdk.png
---

## Platform Support
Expand Down
1 change: 1 addition & 0 deletions ios-sdk/swiftui.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: swiftui
title: SwiftUI
description: How to use Tolgee iOS SDK with SwiftUI.
image: /img/og-images/ios-sdk.png
---

## SwiftUI support
Expand Down
1 change: 1 addition & 0 deletions ios-sdk/swizzling.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: swizzling
title: Swizzling NSLocalizedString
description: How to achieve (almost) zero-effort integration with existing NSLocalizedString usage.
image: /img/og-images/ios-sdk.png
---

## Swizzling of Apple's APIs
Expand Down
1 change: 1 addition & 0 deletions js-sdk/about.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ id: about
title: Overview
slug: /
description: 'Tolgee SDK provides the functionality of an i18n library and helps you with formatting, interpolation, or language detection. '
image: /img/og-images/js-sdk.png
---

import { ScreenRecording } from '../platform/shared/_ScreenRecording';
Expand Down
1 change: 1 addition & 0 deletions js-sdk/api/core_package/about.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: about
title: About
description: "Tolgee core package is platform agnosting and aims to provide universal basis for all other packages from Tolgee SDK."
image: /img/og-images/js-sdk.png
---

## Tolgee core
Expand Down
1 change: 1 addition & 0 deletions js-sdk/api/core_package/events.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: events
title: Core Events
sidebar_label: Events
image: /img/og-images/js-sdk.png
---

Tolgee events which can be listened through `tolgee.on` method.
Expand Down
1 change: 1 addition & 0 deletions js-sdk/api/core_package/format_simple.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: FormatSimple
sidebar_label: FormatSimple
slug: format-simple
description: Super light formatter, which will enable you to pass variables into translations. It is a subset of ICU format.
image: /img/og-images/js-sdk.png
---

Super light formatter, which will enable you to pass variables into translations.
Expand Down
1 change: 1 addition & 0 deletions js-sdk/api/core_package/observer_options.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ id: observer_options
title: Observer options
sidebar_label: Observer options
slug: observer-options
image: /img/og-images/js-sdk.png
---

Tolgee Observer options which are part of [tolgee options](./options). Allows you to influence `ObserverPlugin` if present.
Expand Down
1 change: 1 addition & 0 deletions js-sdk/api/core_package/options.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: options
title: Core Options
sidebar_label: Options
image: /img/og-images/js-sdk.png
---

Initial configuration object of tolgee.
Expand Down
1 change: 1 addition & 0 deletions js-sdk/api/core_package/other_tools.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: other_tools
title: Other tools
slug: other-tools
image: /img/og-images/js-sdk.png
---

Other helper functions exported in `@tolgee/core`.
Expand Down
1 change: 1 addition & 0 deletions js-sdk/api/core_package/plugin.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ id: plugin
title: Plugin
slug: plugin-api
description: Plugin is a function which receives tolgee instance and additional `tools` object, where you have access to additional methods for adding different middlewares.
image: /img/og-images/js-sdk.png
---

## TolgeePlugin interface
Expand Down
1 change: 1 addition & 0 deletions js-sdk/api/core_package/tolgee.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: tolgee
title: Tolgee
description: TolgeeCore allows you to gradually initialize Tolgee instance. You can repeatedly call `use` and `updateDefaults`.
image: /img/og-images/js-sdk.png
---

## TolgeeCore
Expand Down
1 change: 1 addition & 0 deletions js-sdk/api/packages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ id: packages
title: Packages
sidebar_label: Packages
slug: /sdk/packages
image: /img/og-images/js-sdk.png
---

Tolgee SDK is split into several npm packages.
Expand Down
1 change: 1 addition & 0 deletions js-sdk/api/web_package/about.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: about
title: About
sidebar_label: About
image: /img/og-images/js-sdk.png
---

## Tolgee web
Expand Down
1 change: 1 addition & 0 deletions js-sdk/api/web_package/constants.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: constants
title: Constants
slug: constants
image: /img/og-images/js-sdk.png
---

```ts
Expand Down
1 change: 1 addition & 0 deletions js-sdk/api/web_package/plugins.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: plugins
title: Plugins
sidebar_label: Plugins
image: /img/og-images/js-sdk.png
---

## Tolgee
Expand Down
1 change: 1 addition & 0 deletions js-sdk/api/web_package/tools.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ id: tools
title: Tools
sidebar_label: Tools
slug: tools
image: /img/og-images/js-sdk.png
---


Expand Down
1 change: 1 addition & 0 deletions js-sdk/fetching_translations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: fetching_translations
title: Fetching translations
description: Learn how to use the Tolgee SDK to fetch translation files, prefetch data for server-side rendering, and manage caching strategies effectively.
image: /img/og-images/js-sdk.png
---

:::info
Expand Down
1 change: 1 addition & 0 deletions js-sdk/filter_by_tags.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: filter_by_tags
title: Filter keys by tags
description: Learn how to configure the Tolgee SDK to filter translation keys by tags, enabling targeted translation loading for different platforms like web and mobile.
image: /img/og-images/js-sdk.png
---

You can configure Tolgee to only use keys with certain tags. This can be useful if you are sharing translations e.g. between multiple platforms (e.g. web and mobile).
Expand Down
1 change: 1 addition & 0 deletions js-sdk/formatting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: formatting
title: Formatting
description: 'Learn how to use in-context translating feature in Tolgee tool and how to enable in-context translating on production.'
image: /img/og-images/js-sdk.png
---

Formating is a way how to render translation into a final string, with variable parameters. Formatters are supported in form of [plugin](./plugins.mdx).
Expand Down
1 change: 1 addition & 0 deletions js-sdk/get_started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: get_started
title: Get started
description: 'Learn how to get started with the Tolgee SDK for seamless localization. Use framework-specific SDKs or the vanilla JavaScript SDK to easily integrate localization into your application.'
image: /img/og-images/js-sdk.png
---

Tolgee SDK supports multiple frameworks and libraries. These specific SDKs are all based on the [`@tolgee/web`](./api/web_package/about) package. Tolgee also integrates seamlessly with [i18next](https://www.i18next.com/). Use [Tolgee's i18next plugin](./integrations/i18next/installation) if you are already using i18next or need more advanced featured offered by i18next. You can also use Tolgee with [Vanilla JavaScript](./integrations/vanilla/installation).
Expand Down
1 change: 1 addition & 0 deletions js-sdk/in_context.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ id: in_context
title: In-context translating
slug: in-context
description: 'Learn how to use in-context translating feature in Tolgee tool and how to enable in-context translating on production.'
image: /img/og-images/in-context.png
---

For local development, supply `apiUrl`, `apiKey` options (see [Integration](/platform/integrations/about_integrations)) and [`DevTools`](./api/web_package/plugins#devtools) plugin. If you set everything properly, you can use in-context translating:
Expand Down
1 change: 1 addition & 0 deletions js-sdk/integrations/angular/api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ id: api
title: API
sidebar_label: API
description: "Tolgee enables you to implement localization in your Angular application with ease. You can integrate Tolgee in your Angular application using Tolgee's integration library for Angular. Learn about NgxTolgeeModule, TranslateService, T-component, and other APIs."
image: /img/og-images/angular.png
---

The `@tolgee/ngx` library exports the following components and all available components from [`@tolgee/web`](/api/web_package/about.mdx).
Expand Down
1 change: 1 addition & 0 deletions js-sdk/integrations/angular/html_tags.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ id: html_tags
title: Strings with HTML Tags
sidebar_label: Strings with HTML Tags
description: "Tolgee enables you to implement localization in your Angular application with ease. You can integrate Tolgee in your Angular application using Tolgee's integration library for Angular. Learn how to render i18n strings with HTML tags in Angular."
image: /img/og-images/angular.png
---

You can render HTML tags in translations using the [`t` attribute](./translating#t-attribute) or the [`translate` pipe](./translating#translate-pipe).
Expand Down
1 change: 1 addition & 0 deletions js-sdk/integrations/angular/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ id: installation
title: Installation
sidebar_label: Installation
description: "Tolgee enables you to implement localization in your Angular application with ease. You can integrate Tolgee in your Angular application using Tolgee's integration library for Angular. To use this library, start by installing Tolgee."
image: /img/og-images/angular.png
---

import { InstallationTabs } from '../../../src/component/InstallationTabs';
Expand Down
1 change: 1 addition & 0 deletions js-sdk/integrations/angular/namespaces.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ id: namespaces
title: Namespaces
sidebar_label: Namespaces
description: "Tolgee enables you to implement localization in your Angular application with ease. You can integrate Tolgee in your Angular application using Tolgee's integration library. You can split your i18n data into multiple namespaces using Tolgee. Learn more about using namespaces."
image: /img/og-images/angular.png
---

Tolgee allows you to split your i18n data into multiple namespaces. When using the [`translate pipe`](./translating#translate-pipe), [`t attribute`](./translating#t-attribute), or [`translation methods`](./translating#translation-methods), Tolgee automatically loads the namespace data for you.
Expand Down
1 change: 1 addition & 0 deletions js-sdk/integrations/angular/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ id: overview
title: Tolgee with Angular
sidebar_label: Overview
description: "Get started with Tolgee's integration for Angular. Learn how to add localization to your Angular applications."
image: /img/og-images/angular.png
---

Tolgee provides an SDK for Angular, based on the [`@tolgee/web`](../../api/web_package/about) package. Using the SDK [@tolgee/ngx](https://www.npmjs.com/package/@tolgee/ngx), you can connect your Angular application to the Tolgee platform. This SDK enables you to implement [in-context translations](../../in-context), [language detection](../../language#language-detection), interpolation, and other advanced features.
Expand Down
1 change: 1 addition & 0 deletions js-sdk/integrations/angular/switching_language.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: Switching language
sidebar_label: Switching language
slug: switching-language
description: "Tolgee enables you to implement localization in your Angular application with ease. You can integrate Tolgee in your Angular application using Tolgee's integration library for Angular. Learn to manage language change using the TranslationService"
image: /img/og-images/angular.png
---

To manage an event like language change, the Tolgee integration provides the [`TranslationService`](./api#translateservice).
Expand Down
1 change: 1 addition & 0 deletions js-sdk/integrations/angular/translating.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ id: translating
title: Translating
sidebar_label: Translating
description: "Tolgee enables you to implement localization in your Angular application with ease. You can integrate Tolgee in your Angular application using Tolgee's integration library for Angular. Learn to impelement translation using the various methods."
image: /img/og-images/angular.png
---

import TFunctionHint from '../../shared/_TFunctionHint.mdx';
Expand Down
1 change: 1 addition & 0 deletions js-sdk/integrations/i18next/api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ id: api
title: Tolgee i18next API Reference
sidebar_label: API Reference
description: 'Full integration options and custom integration functions for granular control over i18next and Tolgee integration.'
image: /img/og-images/i18next.png
---

## Full integration
Expand Down
1 change: 1 addition & 0 deletions js-sdk/integrations/i18next/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ id: installation
title: Installation
sidebar_label: Installation
description: 'Learn how to integrate Tolgee with i18next to enhance your internationalization workflow while maintaining familiar i18next features.'
image: /img/og-images/i18next.png
---

import PreparingForProduction from '../../shared/_PreparingForProduction.mdx';
Expand Down
1 change: 1 addition & 0 deletions js-sdk/integrations/i18next/react_integration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: React integration using i18next
sidebar_label: React integration
slug: react-integration
description: 'Learn how to integrate Tolgee with React applications using i18next and react-i18next. This guide covers installation, setup, and best practices for internationalization in React projects.'
image: /img/og-images/i18next.png
---

import {InstallationTabs} from "../../../src/component/InstallationTabs";
Expand Down
1 change: 1 addition & 0 deletions js-sdk/integrations/i18next/vue_integration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: Vue integration using i18next
sidebar_label: Vue integration
slug: vue-integration
description: 'Learn how to integrate Tolgee with Vue 2 applications using i18next and @panter/vue-i18next. This guide covers installation, setup, and usage for effective internationalization in Vue 2 projects.'
image: /img/og-images/i18next.png
---

import {InstallationTabs} from "../../../src/component/InstallationTabs";
Expand Down
1 change: 1 addition & 0 deletions js-sdk/integrations/react/api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ id: api
title: API (React)
sidebar_label: API
description: 'API documentation for React integration: TolgeeProvider, T-component and different hooks ( useCurrentLanguage, useSetLanguage, useTranslate).'
image: /img/og-images/react.png
---

## TolgeeProvider
Expand Down
1 change: 1 addition & 0 deletions js-sdk/integrations/react/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ id: installation
title: Installation
sidebar_label: Installation
description: "Tolgee enables you to implement localization in your React application with ease. You can integrate Tolgee in your React application using Tolgee's SDK for React. To use this SDK, start by installing Tolgee for React."
image: /img/og-images/react.png
---

To use Tolgee in your React application, you need to follow these steps:
Expand Down
1 change: 1 addition & 0 deletions js-sdk/integrations/react/next/app_router.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ id: app-router
sidebar_label: App router
title: Next.js with App Router
description: "Get started with Tolgee's integration for Next.js. Learn how to add localization to your Next.js applications that uses the App Router."
image: /img/og-images/next.png
---

import AppRouterTranslating from './shared/_AppRouterTranslating.mdx'
Expand Down
Loading