PolyLingo GitHub Action — translate JSON i18n and Markdown in CI
The official PolyLingo Translate GitHub Action (source) runs in your repository and calls the same API as the dashboard and SDKs. It is aimed at teams who keep flat JSON message files (for example next-intl, i18next, or custom bundles) and Markdown docs next to their code.
Why use it
- Delta mode — Re-translate only namespaces that changed versus a committed baseline snapshot, so routine copy edits do not burn a full multi-locale run every time.
- Large Markdown — Documentation uses the async jobs API with polling, so big
README-style files are not limited by HTTP timeouts. - Official Node SDK — The action shells out to scripts that use the
polylingonpm package, the same surface as our Node SDK docs.
Quick start
- Create a PolyLingo API key in the dashboard.
- Add it as a repository secret, e.g.
POLYLINGO_API_KEY. - Add a workflow (see examples in the action repo under
examples/):
- uses: UsePolyLingo/translate-action@v1
with:
api_key: ${{ secrets.POLYLINGO_API_KEY }}
messages_dir: frontend/messages
with_docs: true
docs_dir: docs
Adjust messages_dir, source_file, docs_dir, and commit_add_paths to match your layout.
Marketplace
The listing is PolyLingo Translate on the GitHub Marketplace (category Utilities). Pin with @v1 for semver-style updates.
Learn more
- API reference —
/translate,/jobs, formats. - ACTION_ROADMAP — how we dogfood the same scripts on the marketing site.