Skip to content

README.md

Latest commit

 

History

History
45 lines (28 loc) · 2.04 KB

README.md

File metadata and controls

45 lines (28 loc) · 2.04 KB
Raw

Markdown Docs Localization Example

Demonstrates localizing a Markdown + MDX documentation set with the Lingo.dev CLI (@lingo.dev/cli) push/pull flow.

Full walkthrough: lingo.dev/en/guides/static-content

What's inside

  • docs/en/**/*.md, docs/en/**/*.mdx — source documentation (English)
  • .lingo/config.json — Lingo.dev CLI configuration (two formats: md and mdx)

Quick start

# 1. Install the CLI (or prefix commands with `npx`)
npm install -g @lingo.dev/cli

# 2. Authenticate and link this repo to your engine
lingo login
lingo link

# 3. Translate changed source into every locale
lingo push --wait

Translations are committed per locale under docs/<locale>/…, mirroring the English source tree — this repo ships fully translated. After you edit English source, lingo push --wait translates only the delta. To bootstrap a brand-new locale, add it to .lingo/config.json and run lingo push --backfill-missing.

How it works

lingo push reads every source doc, diffs it against .lingo/lock.json, and translates only new or changed content through your linked engine. Results are written per locale into docs/<locale>/. Frontmatter (title, description), fenced code blocks, tables, and MDX component structure are preserved — only translatable prose, and whitelisted component props (Card title), change.

Automate in CI (optional)

Want translations on every push or PR without running the CLI yourself? See the CI/CD Workflows guide — the Lingo.dev GitHub App translates automatically once installed. The App reads engineId from the committed .lingo/config.json, so run lingo link and commit the updated file before installing it.

Locales

  • Source: en
  • Targets: es, fr, de

Links