Skip to main content
Plain text files store documentation, release notes, and other prose without markup. Hyperlocalise splits the file into paragraph segments, translates each paragraph, and writes the target file back with the same layout. Supported extension: .txt.

​
Source file

Save this example as locales/en-US/notes.txt.

​
Configure your files

Use this i18n.yml for the example, or add its file mapping to your existing bucket. See path templates for other layouts.

​
Translate

Install the CLI and set OPENAI_API_KEY in your project’s .env.local or shell. You can also configure another AI provider.
The dry run previews the work. The second command writes translations to the configured target path and updates the lockfile.

​
Behavior and limitations

  • Paragraphs are separated by one or more blank lines. Line breaks inside a paragraph are preserved.
  • Segments use sequential keys such as txt.0001. There is no markup to protect; characters like # and [ are translated as plain text.
  • Target alignment uses content fingerprints, so inserting or removing paragraphs in the target file does not shift unrelated translations during hyperlocalise check.
  • Whole-file writeback replaces the target document from approved segment translations, similar to Markdown and AsciiDoc document workflows in Platform File view.

​
Next steps