translation-sync

Synchronize English MDX files with Urdu translations for Docusaurus i18n.

Updated Dec 29, 2025

Search Tags:#translation #glossary #i18n #docusaurus #rtl #urdu

Ready to run

npx skills add https://github.com/FAIQahm/hackathon_I_book --skill translation-sync

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: translation-sync
Source: https://github.com/FAIQahm/hackathon_I_book/tree/main/.claude/skills/translation-sync
Command: npx skills add https://github.com/FAIQahm/hackathon_I_book --skill translation-sync

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires openai, rich, pyyaml, and includes scripts (resource) and assets (resource) components.

What problem does it solve?

Synchronize English MDX docs with Urdu translations in Docusaurus i18n workflows, preserving code blocks, RTL formatting, and glossary-driven terminology across large doc sets.

Core Features & Use Cases

Incremental section-level translation to minimize API calls while keeping translations in sync with source.
Glossary-driven terminology preservation, translation memory, and RTL support for Urdu rendering.
Per-file status tracking, frontmatter handling, and optional translation of select metadata.

Quick Start

Set OPENAI_API_KEY and run a full or incremental sync on your docs directory to generate Urdu translations in the i18n folder, then review diffs before publishing.

Frequently Asked Questions about translation-sync

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I translate Docusaurus MDX files into Urdu while preserving code blocks?▼

To translate Docusaurus MDX files into Urdu while preserving code blocks, you need a synchronization tool that analyzes source MDX files, applies incremental translations, and exports Urdu files to the i18n directory without altering embedded code.

What is the best way to keep Urdu translations in sync with English documentation?▼

The best way to keep Urdu translations in sync is using incremental section-level translation. This minimizes API calls by only translating updated content sections while leveraging translation memory and a glossary to ensure consistent terminology across large doc sets.

Does Docusaurus i18n support right-to-left (RTL) formatting for Urdu?▼

Yes, Docusaurus i18n supports right-to-left (RTL) formatting for Urdu. Translation synchronization tools can preserve RTL formatting and frontmatter metadata during the MDX translation process, ensuring correct rendering and layout for Urdu readers.

How do I ensure consistent terminology when translating MDX docs?▼

To ensure consistent terminology when translating MDX docs, use a glossary-driven translation approach. This technique preserves predefined glossary terms during translation and pairs with translation memory to maintain identical phrasing across multiple files.

Do I need an OpenAI API key to automate MDX translation?▼

Yes, you need an OpenAI API key to automate MDX translation using this synchronization tool. You must set the OPENAI_API_KEY environment variable before running a full or incremental sync on your docs directory to generate the translated files.

Can I track the translation status of individual MDX files?▼

Yes, you can track the translation status of individual MDX files. The synchronization process includes per-file status tracking, allowing you to monitor which documents have been successfully translated and exported to the i18n directory before publishing.