mkdocs-translations

Translate MkDocs documentation from English to a target locale while preserving structure and formatting.

Updated Apr 14, 2026
One-click install
npx skills add https://github.com/BrunoAMSilva/my-config --skill mkdocs-translations-brunoamsilva
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: mkdocs-translations
Source: https://github.com/BrunoAMSilva/my-config/tree/main/coding/skills/mkdocs-translations
Command: npx skills add https://github.com/BrunoAMSilva/my-config --skill mkdocs-translations-brunoamsilva

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Translates MkDocs documentation from English sources into a user-selected language, enabling broader accessibility and localized technical content.

Core Features & Use Cases

  • Preserve the original folder structure and Markdown formatting while translating content.
  • Update navigation and admonition translations via MkDocs i18n plugin to reflect the target locale.
  • Apply translations to both docs/docs/en and docs/docs/includes/en to ensure complete coverage.

Quick Start

Specify the target language and locale code, then start the translation workflow.

Frequently Asked Questions about mkdocs-translations

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I translate MkDocs documentation into another language?

To translate MkDocs documentation, you specify a target language and locale code to start the workflow. The process mirrors the English Markdown structure from docs/docs/en into a new localized directory while preserving original filenames and formatting.

Does MkDocs i18n plugin translation update navigation and admonitions automatically?

MkDocs i18n plugin translation updates navigation and admonitions automatically during the workflow. The process specifically configures nav_translations and admonition_translations to ensure the localized documentation reflects the target locale accurately.

How do I keep Markdown formatting when translating technical documentation?

Markdown formatting is preserved during translation by mirroring the source structure and retaining original filenames. This ensures localized technical content maintains its layout and structural integrity across the target language files.

Can I translate MkDocs include files alongside the main documentation?

You can translate MkDocs include files alongside main documentation by processing docs/docs/includes/en. The workflow mirrors these included files into docs/docs/includes/<locale_code>/ to ensure complete localization coverage.

How do I ensure consistent terminology across translated MkDocs files?

Consistent terminology across translated MkDocs files is enforced by the translation workflow logic. It applies uniform terms throughout all generated localized Markdown files to maintain technical accuracy and coherence.

What is the best way to structure localized MkDocs files for multiple languages?

The best way to structure localized MkDocs files is to mirror the English directories under docs/docs/<locale_code>/ and docs/docs/includes/<locale_code>/. This approach maintains the original folder hierarchy and filenames for every target language.