https://github.com/moki/json-translation
generate xliff and skeleton file for json, compose json from xliff and skeleton files
https://github.com/moki/json-translation
Last synced: about 2 months ago
JSON representation
generate xliff and skeleton file for json, compose json from xliff and skeleton files
- Host: GitHub
- URL: https://github.com/moki/json-translation
- Owner: moki
- Created: 2023-12-14T13:08:38.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-20T11:59:58.000Z (over 1 year ago)
- Last Synced: 2025-02-10T08:46:40.275Z (4 months ago)
- Language: TypeScript
- Size: 130 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
Awesome Lists containing this project
README
# json-translation
## 📚 Sections
- [👋 Introduction](#-introduction)
- [🌟 Project Overview](#-project-overview)
- [🎯 Purpose and Scope](#-purpose-and-scope)
- [🚀 Getting Started](#-getting-started)
- [💻 Installation](#-installation)
- [📖 API](#-api)
- [💡 Usage](#-usage)
- [🧠 Architecture](#-architecture)
## 👋 Introduction
Hey, There!
This library helps you to translate your json data that is structured with json schema.
In the end you will be able to easily generate XLF and skeleton files for CATs from your json, and compose XLF and skeleton into translated json.
Library supports Markdown syntax inside translatable strings, by heavily relying on [markdown-translation](https://github.com/diplodoc-platform/markdown-translation) library.
## 🌟 Project Overview
This library provides two API interfaces extract and compose.
Extract strings from json fields marked as translatable in the json schema and generate skeleton and XLF files.
Compose translated XLF and skeleton into translated json.
Say goodbye to manual editing work and streamline your workflow with json-translation.
## 🎯 Purpose and Scope
🤯 This library is tackling some serious problems with json translations!
🚫 Say goodbye to unnecessary heavy load on translators caused by naive approaches that include markdown syntax constructs into text segments.
💥 "collisions" - yikes! But fear not, this library has got your back with a reliable solution for extracting/composing translatable markdown from json data.
🕵️♀️ How? By combining power of parsers and custom renderers!
🧑💻 Say goodbye to those problems and hello to efficient and accurate translations with json-translation!
## 🚀 Getting Started
### 💻 Installation
```
npm install @diplodoc/json-translation
```
### 📖 API
#### 🔍 extract ✨
#### 🔤 compose ✨
### 👨💻 Usage
#### 🔍 Extract
#### 🔤 Compose
## 🧠 Architecture
