
Mkdocs Translations
Localize an entire MkDocs English tree under docs/docs/en and includes into a target language while preserving structure and Markdown.
Overview
MkDocs Translations is an agent skill for the Build phase that translates all English MkDocs content under docs/docs/en and includes into a user-specified locale while preserving structure and formatting.
Install
npx skills add https://github.com/github/awesome-copilot --skill mkdocs-translationsWhat is this skill?
- Requires user-confirmed target language and locale (es, fr, pt-BR, ko, etc.) before translating
- Translates docs/docs/en and docs/docs/includes/en with original folder structure preserved
- Checklist-driven: list trees, translate every file one by one, continue automatically without approval prompts
- Professional technical-writer and translator role with Markdown formatting preserved
- 2 source trees: docs/docs/en and docs/docs/includes/en
- Checklist requires listing both trees then translating every file one by one without stopping for confirmation
Adoption & trust: 8.5k installs on skills.sh; 34.6k GitHub stars; 3/3 security scanners passed (skills.sh audits).
What problem does it solve?
Your MkDocs site is English-only and duplicating every page by hand for a new locale would take days and break includes.
Who is it for?
Indie products with MkDocs Material (or similar) stacks preparing es/fr/pt-BR/ko documentation expansions.
Skip if: Non-MkDocs doc systems (Docusaurus-only, Notion exports) or one-off README translation without a docs/docs/en layout.
When should I use this skill?
You need to generate a language translation for a MkDocs documentation stack after the user specifies target language and locale code.
What do I get? / Deliverables
You get a fully walked translation pass with mirrored paths and consistent locale naming, ready for MkDocs configuration updates for the new language.
- Translated markdown files mirroring English directory structure
- Completed checklist progress across all listed en files
Recommended Skills
Journey fit
Build → docs is the canonical home for documentation site maintenance and i18n expansion on MkDocs stacks. Translation is a docs pipeline task: mirrored folders, locale codes, and MkDocs config updates—not application runtime code.
How it compares
Use for site-wide MkDocs locale mirroring, not for commenting a single Python script into a tutorial README.
Common Questions / FAQ
Who is mkdocs-translations for?
Builders maintaining MkDocs repos who need structured EN→locale translation across docs and include fragments.
When should I use mkdocs-translations?
In Build → docs when English pages under docs/docs/en are complete enough to freeze and you are adding a new language folder before launch or growth in that market.
Is mkdocs-translations safe to install?
It mass-writes translated markdown across the repo; diff carefully for PII or secrets in source docs and review the Security Audits panel on this Prism page.
SKILL.md
READMESKILL.md - Mkdocs Translations
# MkDocs AI Translator ## Role You are a professional technical writer and translator. ## Required Input **Before proceeding, ask the user to specify the target translation language and locale code.** Examples: - Spanish (`es`) - French (`fr`) - Brazilian Portuguese (`pt-BR`) - Korean (`ko`) Use this value consistently in folder names, translated content paths, and MkDocs configuration updates. Once confirmed, proceed with the instructions below. --- ## Objective Translate all documentation from the `docs/docs/en` and `docs/docs/includes/en` folders into the specified target language. Preserve the original folder structure and all Markdown formatting. --- ## File Listing and Translation Order The following is the task list you must complete. Check each item off as it is done and report that to the user. - [ ] Begin by listing all files and subdirectories under `docs/docs/en`. - [ ] Then list all files and subdirectories under `docs/docs/includes/en`. - [ ] Translate **every file** in the list **one by one** in the order shown. Do not skip, reorder, or stop after a fixed number of files. - [ ] After each translation, **check whether there are remaining files** that have not yet been translated. If there are, **continue automatically** with the next file. - [ ] Do **not** prompt for confirmation, approval, or next steps—**proceed automatically** until all files are translated. - [ ] Once completed, confirm that the number of translated files matches the number of source files listed. If any files remain unprocessed, resume from where you left off. --- ## Folder Structure and Output Before starting to create **any** new files, create a new git branch using the terminal command `git checkout -b docs-translation-<language>`. - Create a new folder under `docs/docs/` named using the ISO 639-1 or locale code provided by the user. Examples: - `es` for Spanish - `fr` for French - `pt-BR` for Brazilian Portuguese - Mirror the exact folder and file structure from the original `en` directories. - For each translated file: - Preserve all Markdown formatting, including headings, code blocks, metadata, and links. - Maintain the original filename. - Do **not** wrap the translated content in Markdown code blocks. - Append this line at the end of the file: *Translated using GitHub Copilot and GPT-4o.* - Save the translated file into the corresponding target language folder. --- ## Include Path Updates - Update include references in files to reflect the new locale. Example: `includes/en/introduction-event.md` → `includes/es/introduction-event.md` Replace `es` with the actual locale code provided by the user. --- ## MkDocs Configuration Update - [ ] Modify the `mkdocs.yml` configuration: - [ ] Add a new `locale` entry under the `i18n` plugin using the target language code. - [ ] Provide appropriate translations for: - [ ] `nav_translations` - [ ] `admonition_translations` --- ## Translation Rules - Use accurate, clear, and technically appropriate translations. - Always use computer industry-standard terminology. Example: prefer "Stack Tecnológica" over "Pila Tecnológica". **Do not:** - Comment on, suggest changes for, or attempt to fix any formatting or Markdown linting issues. This includes, but is not limited to: - Missing blank lines around headings or lists - Trailing punctuation in headings - Missing alt text for images - Improper heading levels - Line length or spacing issues - Do not say things like: _"There are some linting issues, such as…"_ _"Would you like me to fix…"_ - Never prompt the user about any linting or formatting issues. - Do not wait for confirmation before continuing. - Do not wrap the translated content or file in Markdown code blocks. --- ## Translating Includes (`docs/docs/includes/en`) - Create