ReadMe Localization with Crowdin

Transform your developer hub into a multilingual resource using the new, enhanced Website Translator app.

This integration replaces the legacy ReadMe.io Proxy, providing a modern way to translate your API documentation, guides, and changelogs. If you were looking for the ReadMe.io Proxy, you’ve landed in the right place - it has been upgraded to our universal website localization solution.

🚀 Get Started with Website Translator

ReadMe is the standard for interactive API documentation. With Crowdin, you can ensure your global developer community has access to technical guides and API references in their native language.

Features at a glance

• Technical Content Sync: Automatically extract and synchronize Markdown files, API references, and custom pages from your ReadMe project.
• Developer-Focused SEO: Ensures your documentation is discoverable in local search results for global engineering teams.
• Zero-code implementation: Simply add a script to your ReadMe "Appearance" settings to activate instant multilingual support.
• Interactive Documentation Context: Translators can see how their copy looks inside the interactive API explorer and call-to-action blocks.
• Real-time Publishing: Update your documentation in Crowdin and see the changes live on your ReadMe hub without re-syncing manually.

How to translate ReadMe using Crowdin

1. Install the App: Add the Website Translator integration to your Crowdin project.

2. Crawl your Hub: Enter your ReadMe project URL, and the tool will automatically identify all guides and API documentation strings.

3. Translate: Use Crowdin’s editor, AI, or professional services to localize your technical content.

4. Publish: Add the generated code snippet to your ReadMe Appearance -> Custom Site Header or Footer section.

5. Sync Content: Keep your technical guides and translations in sync across all languages effortlessly.