mkdocs-translations

Translate MkDocs Markdown files and update mkdocs.yml for i18n.

Updated Nov 21, 2025
One-click install
npx skills add https://github.com/lluppesms/dadabase.demo --skill mkdocs-translations
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: mkdocs-translations
Source: https://github.com/lluppesms/dadabase.demo/tree/main/.github/skills/mkdocs-translations
Command: npx skills add https://github.com/lluppesms/dadabase.demo --skill mkdocs-translations

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill automates the translation of MkDocs documentation into specified target languages, ensuring your documentation is accessible to a global audience.

Core Features & Use Cases

  • Full Documentation Translation: Translates all Markdown files within specified directories (docs/docs/en and docs/docs/includes/en).
  • Preserves Structure and Formatting: Maintains original folder structure, filenames, and Markdown formatting.
  • Automated Workflow: Translates files sequentially without requiring user confirmation for each step.
  • MkDocs Configuration Update: Automatically updates mkdocs.yml for internationalization (i18n) support.
  • Use Case: A software company needs to make its technical documentation available in Spanish and Brazilian Portuguese. This Skill can be invoked for each language to generate the translated content and update the MkDocs configuration.

Quick Start

Use the mkdocs-translations skill to translate the documentation into French (fr).

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?

This Skill translates MkDocs documentation by processing Markdown files in `docs/docs/en` and `docs/docs/includes/en`, converting content into a specified target language while preserving folder structure and Markdown formatting.

Does translating MkDocs Markdown files preserve the original folder structure?

Yes, the translation process preserves the original folder structure, filenames, and Markdown formatting, ensuring the localized output matches the source directory layout without breaking internal links.

Can I automatically update mkdocs.yml for i18n support during translation?

Yes, the Skill automatically updates `mkdocs.yml` for internationalization (i18n) support during the translation process, ensuring the MkDocs configuration recognizes the newly generated localized content.

Do I need Git to automate MkDocs localization?

Yes, Git is required to automate MkDocs localization. The Skill uses Git specifically for creating branches to manage and isolate the translated documentation output effectively.

What is the best way to translate technical writing in MkDocs without breaking formatting?

The best way is using an automated process that applies strict translation rules for technical terminology while preserving Markdown syntax. This ensures your technical writing remains structurally intact during localization.

What are the limitations of automating i18n for MkDocs documentation?

Limitations include requiring source files to be strictly located within `docs/docs/en` and `docs/docs/includes/en` directories, and depending on Git for branch creation to manage the translated output.