General Translation

# Docs

## cli

- [Auth](/en-US/docs/cli/auth): Authenticate your project with General Translation
- [Configure](/en-US/docs/cli/configure): Configure your project's GT settings
- [FAQs](/en-US/docs/cli/faqs): Frequently Asked Questions
- [Generate Source Template](/en-US/docs/cli/generate): How to generate a source template for your project
- [Automatic Translation](/en-US/docs/cli): How to automatically translate your project using the General Translation CLI tool
- [Setup Wizard](/en-US/docs/cli/init): Run the GT setup wizard
- [Save Local Edits](/en-US/docs/cli/save-local): How to save edits made to local translation files
- [Stage](/en-US/docs/cli/stage): How to stage your translations for review
- [Translate](/en-US/docs/cli/translate): How to translate your project
- [GT JSX](/en-US/docs/cli/formats/gt): Automatically translate your gt-next, gt-react, or gt-react-native project
- [HTML](/en-US/docs/cli/formats/html): How to use General Translation to set up automatic translation for HTML files
- [JSON](/en-US/docs/cli/formats/json): How to automatically translate JSON files with General Translation
- [Markdown](/en-US/docs/cli/formats/mdx): How to use General Translation to set up automatic translation for your project's Markdown files
- [TypeScript](/en-US/docs/cli/formats/ts): How to automatically translate TypeScript and JavaScript files with General Translation
- [Text](/en-US/docs/cli/formats/txt): How to use General Translation to set up automatic translation for your project's text files
- [Configuration](/en-US/docs/cli/reference/config): Config docs for the gt.config.json file
- [Usage Guide](/en-US/docs/cli/reference/usage): Usage guide for the GT command line tool

## core

- [FAQs](/en-US/docs/core/faqs): Frequently Asked Questions
- [Overview](/en-US/docs/core): Overview of the generaltranslation library
- [Locales](/en-US/docs/core/locales): What are locales and how are they used in the General Translation stack?
- [Quickstart](/en-US/docs/core/quickstart): Quick Start guide for the generaltranslation library
- [GT Constructor](/en-US/docs/core/class/constructor): API reference for the GT class constructor
- [setConfig](/en-US/docs/core/class/set-config): API reference for the GT setConfig method
- [Content](/en-US/docs/core/types/Content): Union type representing all supported content formats for translation
- [Entry](/en-US/docs/core/types/Entry): Type definition for translation entries used in batch translation operations
- [Variable](/en-US/docs/core/types/Variable): Type definition for variables used in translation content
- [CustomMapping](/en-US/docs/core/types/custom-mapping): Type definition for custom locale code mappings and enhanced locale metadata
- [DataFormat](/en-US/docs/core/types/data-format): Enumeration of supported content format types for translation
- [EnqueueFilesOptions](/en-US/docs/core/types/enqueue-files-options): Configuration options for batch file translation operations
- [EntryMetadata](/en-US/docs/core/types/entry-metadata): Type definition for metadata that customizes translation behavior in Entry objects
- [FileToTranslate](/en-US/docs/core/types/file-to-translate): Type definition for file objects used in batch file translation operations
- [GTConstructorParams](/en-US/docs/core/types/gt-constructor-params): TypeScript interface for GT class constructor parameters
- [JsxChild](/en-US/docs/core/types/jsx-child): Union type representing individual elements within JSX content
- [JsxChildren](/en-US/docs/core/types/jsx-children): Type definition for JSX content that can be translated and rendered
- [JsxElement](/en-US/docs/core/types/jsx-element): Type definition for structured HTML-like elements in translatable JSX content
- [LocaleProperties](/en-US/docs/core/types/locale-properties): TypeScript interface containing comprehensive locale information
- [TranslateManyResult](/en-US/docs/core/types/translate-many-result): Type definition for results returned by batch translation operations
- [TranslationResult](/en-US/docs/core/types/translation-result): Type definition for translation results returned by translate() methods
- [VariableType](/en-US/docs/core/types/variable-type): Enumeration of variable formatting types for dynamic content translation
- [formatCutoff](/en-US/docs/core/functions/formatting/format-cutoff): Standalone function to truncate strings with locale-aware terminators
- [formatDateTime](/en-US/docs/core/functions/formatting/format-date-time): Standalone function to format dates and times according to locale conventions
- [formatMessage](/en-US/docs/core/functions/formatting/format-message): API reference for the standalone formatMessage function
- [formatNum](/en-US/docs/core/functions/formatting/format-num): Standalone function to format numbers according to locale conventions
- [determineLocale](/en-US/docs/core/functions/locales/determine-locale): API reference for the determineLocale function
- [getLocaleDirection](/en-US/docs/core/functions/locales/get-locale-direction): API reference for the getLocaleDirection function
- [getLocaleEmoji](/en-US/docs/core/functions/locales/get-locale-emoji): API reference for the standalone getLocaleEmoji function
- [getLocaleName](/en-US/docs/core/functions/locales/get-locale-name): API reference for the standalone getLocaleName function
- [getLocaleProperties](/en-US/docs/core/functions/locales/get-locale-properties): API reference for the standalone getLocaleProperties function
- [getRegionProperties](/en-US/docs/core/functions/locales/get-region-properties): API reference for the getRegionProperties function
- [isSameDialect](/en-US/docs/core/functions/locales/is-same-dialect): API reference for the isSameDialect function
- [isSameLanguage](/en-US/docs/core/functions/locales/is-same-language): API reference for the isSameLanguage function
- [isSupersetLocale](/en-US/docs/core/functions/locales/is-superset-locale): API reference for the isSupersetLocale function
- [isValidLocale](/en-US/docs/core/functions/locales/is-valid-locale): API reference for the isValidLocale function
- [requiresTranslation](/en-US/docs/core/functions/locales/requires-translation): API reference for the requiresTranslation function
- [resolveAliasLocale](/en-US/docs/core/functions/locales/resolve-alias-locale): API reference for the resolveAliasLocale function
- [standardizeLocale](/en-US/docs/core/functions/locales/standardize-locale): API reference for the standardizeLocale function
- [formatCutoff](/en-US/docs/core/class/methods/formatting/format-cutoff): API reference for the GT formatCutoff method
- [formatDateTime](/en-US/docs/core/class/methods/formatting/format-date-time): API reference for the formatDateTime method to format dates and times according to locale conventions
- [formatMessage](/en-US/docs/core/class/methods/formatting/format-message): API reference for the GT formatMessage method
- [formatNum](/en-US/docs/core/class/methods/formatting/format-num): API reference for the formatNum method to format numbers according to locale conventions
- [determineLocale](/en-US/docs/core/class/methods/locales/determine-locale): API reference for the GT determineLocale method
- [getLocaleDirection](/en-US/docs/core/class/methods/locales/get-locale-direction): API reference for the GT getLocaleDirection method
- [getLocaleEmoji](/en-US/docs/core/class/methods/locales/get-locale-emoji): API reference for the GT getLocaleEmoji method
- [getLocaleName](/en-US/docs/core/class/methods/locales/get-locale-name): API reference for the GT getLocaleName method
- [getLocaleProperties](/en-US/docs/core/class/methods/locales/get-locale-properties): API reference for the GT getLocaleProperties method
- [getRegionProperties](/en-US/docs/core/class/methods/locales/get-region-properties): API reference for the GT getRegionProperties method
- [isSameDialect](/en-US/docs/core/class/methods/locales/is-same-dialect): API reference for the GT isSameDialect method
- [isSameLanguage](/en-US/docs/core/class/methods/locales/is-same-language): API reference for the GT isSameLanguage method
- [isSupersetLocale](/en-US/docs/core/class/methods/locales/is-superset-locale): API reference for the GT isSupersetLocale method
- [isValidLocale](/en-US/docs/core/class/methods/locales/is-valid-locale): API reference for the GT isValidLocale method
- [requiresTranslation](/en-US/docs/core/class/methods/locales/requires-translation): API reference for the GT requiresTranslation method
- [resolveAliasLocale](/en-US/docs/core/class/methods/locales/resolve-alias-locale): API reference for the GT resolveAliasLocale method
- [resolveCanonicalLocale](/en-US/docs/core/class/methods/locales/resolve-canonical-locale): API reference for the GT resolveCanonicalLocale method
- [standardizeLocale](/en-US/docs/core/class/methods/locales/standardize-locale): API reference for the GT standardizeLocale method
- [checkJobStatus](/en-US/docs/core/class/methods/translation/check-job-status): API reference for the checkJobStatus method to monitor job progress
- [downloadFileBatch](/en-US/docs/core/class/methods/translation/download-file-batch): API reference for the downloadFileBatch method to download multiple files in a single request
- [downloadFile](/en-US/docs/core/class/methods/translation/download-file): API reference for the downloadFile method to download source or translated files
- [enqueueFiles](/en-US/docs/core/class/methods/translation/enqueue-files): API reference for the enqueueFiles method to enqueue file translation jobs
- [getProjectData](/en-US/docs/core/class/methods/translation/get-project-data): API reference for the getProjectData method to retrieve project information and configuration
- [queryFileData](/en-US/docs/core/class/methods/translation/query-file-data): API reference for the queryFileData method to query source and translation file data
- [querySourceFile](/en-US/docs/core/class/methods/translation/query-source-file): API reference for the querySourceFile method to get source file and translation information
- [setupProject](/en-US/docs/core/class/methods/translation/setup-project): API reference for the setupProject method to initialize translation project setup
- [translateMany](/en-US/docs/core/class/methods/translation/translate-many): API reference for the GT translateMany method for batch translations
- [translate](/en-US/docs/core/class/methods/translation/translate): API reference for the GT translate method
- [uploadSourceFiles](/en-US/docs/core/class/methods/translation/upload-source-files): API reference for the uploadSourceFiles method to upload source files for translation
- [uploadTranslations](/en-US/docs/core/class/methods/translation/upload-translations): API reference for the uploadTranslations method to upload pre-existing translation files

## key-concepts

- [Dynamic Content](/en-US/docs/key-concepts/dynamic-content): A brief overview of working with Dynamic Content in GT.
- [Private Information](/en-US/docs/key-concepts/private-information): A brief overview of working with Private Information in GT.

## locadex