# GitHub README Globalizer (`lenient_grove/github-readme-globalizer`) Actor 🌍 Translate GitHub docs (README, CONTRIBUTING, CHANGELOG) into 16+ languages without breaking code! 🛡️ AI-powered by Lingo.dev with AST parsing to protect code blocks. 📄 Multi-file, 🌿 branch selection, 📥 one-click downloads. Code stays safe! - **URL**: https://apify.com/lenient\_grove/github-readme-globalizer.md - **Developed by:** [Tejas Rawool](https://apify.com/lenient_grove) (community) - **Categories:** Developer tools, Other, AI - **Stats:** 3 total users, 2 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: 5.00 out of 5 stars ## Pricing from $50.00 / 1,000 results This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Since this Actor supports Apify Store discounts, the price gets lower the higher subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## 🌍 Open Source Globalizer **Translate your GitHub documentation into any language without breaking your code.** [![Powered by Lingo.dev](https://img.shields.io/badge/Powered%20by-Lingo.dev-blue?style=for-the-badge)](https://lingo.dev) [![Apify Actor](https://img.shields.io/badge/Apify-Actor-green?style=for-the-badge)](https://apify.com) [![16+ Languages](https://img.shields.io/badge/Languages-16+-orange?style=for-the-badge)](#supported-languages) --- ### 🚀 What It Does This Apify Actor fetches markdown documentation from any GitHub repository, translates it into your chosen languages using **Lingo.dev AI**, and delivers perfectly formatted files ready to commit. > 💡 **Perfect for**: Open source maintainers, documentation teams, and anyone who wants to make their projects accessible globally! --- ### ✨ Key Features | Feature | Description | |---------|-------------| | 🛡️ **Code-Safe** | Uses AST parsing to protect all code blocks, inline code, and commands | | 📄 **Multi-File** | Translate README, CONTRIBUTING, CHANGELOG, and more in one run | | 🌿 **Branch Support** | Specify any branch (main, develop, v2) or auto-detect | | 🌍 **16 Languages** | From Spanish to Thai, covering 2+ billion native speakers | | 📊 **Progress Tracking** | Real-time status updates during translation | | 📥 **Direct Download** | One-click download links for all translated files | --- ### 🌐 Supported Languages | Language | Code | Language | Code | |----------|------|----------|------| | 🇪🇸 Spanish | `es` | 🇰🇷 Korean | `ko` | | 🇫🇷 French | `fr` | 🇸🇦 Arabic | `ar` | | 🇩🇪 German | `de` | 🇮🇹 Italian | `it` | | 🇨🇳 Chinese | `zh` | 🇳🇱 Dutch | `nl` | | 🇯🇵 Japanese | `ja` | 🇵🇱 Polish | `pl` | | 🇧🇷 Portuguese | `pt` | 🇹🇷 Turkish | `tr` | | 🇷🇺 Russian | `ru` | 🇻🇳 Vietnamese | `vi` | | 🇮🇳 Hindi | `hi` | 🇹🇭 Thai | `th` | --- ### 📦 How to Use #### Step 1: Get Your API Key 1. Visit [lingo.dev](https://lingo.dev) 2. Sign up / Sign in 3. Go to Dashboard → Developer API 4. Generate your API Key #### Step 2: Configure the Actor 1. Enter your **GitHub Repository URL** - Example: `https://github.com/apify/crawlee` 2. Select **Branch** (optional, auto-detects if empty) 3. Choose **Files to Translate** - README.md, CONTRIBUTING.md, CHANGELOG.md, etc. 4. Select **Target Languages** - Pick from 16 supported languages 5. Paste your **Lingo.dev API Key** #### Step 3: Run & Download - Click **Start** and watch the progress - Download translated files from the results table --- ### 📊 Output Example Each translation produces a row in the dataset: | File | Language | Status | Words | Download | |------|----------|--------|-------|----------| | README.md | 🇪🇸 Spanish | ✅ Success | 1,250 | [📥 Download](#) | | README.md | 🇨🇳 Chinese | ✅ Success | 1,180 | [📥 Download](#) | | CONTRIBUTING.md | 🇪🇸 Spanish | ✅ Success | 450 | [📥 Download](#) | --- ### 🎯 Use Cases - **Open Source Projects**: Make your documentation accessible to contributors worldwide - **Developer Tools**: Translate SDK documentation for global adoption - **Startups**: Localize your GitHub README for international markets - **Education**: Translate tutorials and guides for students globally --- ### 🔧 Technical Details #### How It Works 1. **Fetch**: Downloads markdown files from GitHub (with branch auto-detection) 2. **Parse**: Uses Remark AST to separate text from code 3. **Translate**: Sends text nodes to Lingo.dev AI (code blocks untouched) 4. **Reassemble**: Rebuilds the markdown with translated content 5. **Deliver**: Stores files with direct download links #### What Stays Untouched - ✅ Code blocks (```js, ```python, etc.) - ✅ Inline code (`npm install`) - ✅ URLs and links - ✅ HTML tags - ✅ Markdown formatting --- ### 📄 License ISC License - Use freely for any purpose. --- *Made with ❤️ by [Tejas Rawool](https://github.com/TejasRawool186) | Powered by [Lingo.dev](https://lingo.dev) & [Apify](https://apify.com)* # Actor input Schema ## `repoUrl` (type: `string`): Full URL (e.g., https://github.com/apify/crawlee). ## `branch` (type: `string`): Git branch to fetch files from (e.g., main, master, develop, v2). Leave empty to auto-detect. ## `filesToTranslate` (type: `array`): Select which markdown files to translate from the repository. ## `targetLanguages` (type: `array`): Select languages to translate into. ## `lingoApiKey` (type: `string`): Your Lingo.dev API Key. To get one: 1) Visit lingo.dev 2) Sign up / Sign in 3) Go to Dashboard 4) Click 'Developer API' 5) Generate your API Key ## Actor input object example ```json { "repoUrl": "https://github.com/apify/crawlee", "branch": "", "filesToTranslate": [ "README.md" ], "targetLanguages": [ "es", "zh" ] } ```` # Actor output Schema ## `dashboard` (type: `string`): Interactive HTML dashboard showing all translated files with download buttons. ## `translations` (type: `string`): Table view of all translated files with language, status, word count, and download links. # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "repoUrl": "https://github.com/apify/crawlee", "filesToTranslate": [ "README.md" ], "targetLanguages": [ "es", "zh" ] }; // Run the Actor and wait for it to finish const run = await client.actor("lenient_grove/github-readme-globalizer").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "repoUrl": "https://github.com/apify/crawlee", "filesToTranslate": ["README.md"], "targetLanguages": [ "es", "zh", ], } # Run the Actor and wait for it to finish run = client.actor("lenient_grove/github-readme-globalizer").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "repoUrl": "https://github.com/apify/crawlee", "filesToTranslate": [ "README.md" ], "targetLanguages": [ "es", "zh" ] }' | apify call lenient_grove/github-readme-globalizer --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=lenient_grove/github-readme-globalizer", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "GitHub README Globalizer", "description": "🌍 Translate GitHub docs (README, CONTRIBUTING, CHANGELOG) into 16+ languages without breaking code! 🛡️ AI-powered by Lingo.dev with AST parsing to protect code blocks. 📄 Multi-file, 🌿 branch selection, 📥 one-click downloads. Code stays safe!", "version": "0.0", "x-build-id": "qCQyRkvl921KcUvsv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lenient_grove~github-readme-globalizer/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lenient_grove-github-readme-globalizer", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/lenient_grove~github-readme-globalizer/runs": { "post": { "operationId": "runs-sync-lenient_grove-github-readme-globalizer", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/lenient_grove~github-readme-globalizer/run-sync": { "post": { "operationId": "run-sync-lenient_grove-github-readme-globalizer", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "repoUrl", "targetLanguages", "lingoApiKey" ], "properties": { "repoUrl": { "title": "GitHub Repository URL", "type": "string", "description": "Full URL (e.g., https://github.com/apify/crawlee)." }, "branch": { "title": "Branch Name", "type": "string", "description": "Git branch to fetch files from (e.g., main, master, develop, v2). Leave empty to auto-detect.", "default": "" }, "filesToTranslate": { "title": "Files to Translate 📄", "type": "array", "description": "Select which markdown files to translate from the repository.", "items": { "type": "string", "enum": [ "README.md", "CONTRIBUTING.md", "CHANGELOG.md", "CODE_OF_CONDUCT.md", "SECURITY.md", "docs/README.md" ], "enumTitles": [ "README.md", "CONTRIBUTING.md", "CHANGELOG.md", "CODE_OF_CONDUCT.md", "SECURITY.md", "docs/README.md" ] } }, "targetLanguages": { "title": "Target Languages 🌍", "type": "array", "description": "Select languages to translate into.", "items": { "type": "string", "enum": [ "es", "fr", "de", "zh", "ja", "pt", "ru", "hi", "ko", "ar", "it", "nl", "pl", "tr", "vi", "th" ], "enumTitles": [ "Spanish", "French", "German", "Chinese", "Japanese", "Portuguese", "Russian", "Hindi", "Korean", "Arabic", "Italian", "Dutch", "Polish", "Turkish", "Vietnamese", "Thai" ] } }, "lingoApiKey": { "title": "Lingo.dev API Key 🔑", "type": "string", "description": "Your Lingo.dev API Key. To get one: 1) Visit lingo.dev 2) Sign up / Sign in 3) Go to Dashboard 4) Click 'Developer API' 5) Generate your API Key" } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } } ```