Markdown

​

Source file

---
title: Product guide
---

# Welcome

Read the [setup guide](./setup.md) to get started.

​

Configure your files

locales:
    source: en-US
    targets:
        - es-ES

buckets:
    messages:
        files:
            - from: locales/en-US/messages.md
              to: locales/{{target}}/messages.md

llm:
    profiles:
        default:
            provider: openai
            model: gpt-5.2

​

Translate

hyperlocalise run --dry-run
hyperlocalise run

​

Behavior and limitations

• Translates prose while retaining Markdown structure and link destinations.
• Frontmatter and fenced code blocks stay unchanged. Translate frontmatter separately if you need localized metadata.
• Segments use sequential keys such as md.0001. Review generated files when restructuring source content.
• Set srx: markdown on a file mapping if you need sentence segmentation. See configuration.

​

Next steps

• Check translations before committing generated files.
• Local translation workflow explains repeat runs.
• Browse all file formats.