# Localization of VTK Documentation

**URL:** https://discourse.vtk.org/t/localization-of-vtk-documentation/16328
**Category:** Support
**Created:** [March 16, 2026, 3:49am UTC](https://discourse.vtk.org/t/localization-of-vtk-documentation/16328 "2026-03-16T03:49:47Z")
**Posts on this page:** 7
**Page:** 1

<div class="post-metadata">

### Author: ![hwhsu1231](https://discourse.vtk.org/user_avatar/discourse.vtk.org/hwhsu1231/32/10561_2.png) [@hwhsu1231](https://discourse.vtk.org/u/hwhsu1231)
#### Post date: [March 16, 2026, 3:49am UTC](https://discourse.vtk.org/t/localization-of-vtk-documentation/16328/1 "2026-03-16T03:49:47Z")

</div>

## Announcement

Hello, VTK community,

I am the author of the [Localize The Docs](https://github.com/localizethedocs) organization. And I’m glad to announce that the 🎉 **vtk-docs-l10n** 🎉 project is published now:

- 🚀 **Preview:** [vtk-docs-l10n](https://projects.localizethedocs.org/vtk-docs-l10n)
- 🌐 **Crowdin:** [vtk-docs-l10n](https://localizethedocs.crowdin.com/vtk-docs-l10n)
- 🐙 **GitHub:** [vtk-docs-l10n](https://github.com/localizethedocs/vtk-docs-l10n)

The goal of this project is to translate the VTK Documentation into multiple languages. Translations are contributed via the Crowdin platform, automatically synchronized with the GitHub repository, and can be previewed on GitHub Pages.

## How to Contribute Translations

To contribute the translations to the project, just follow the following steps:

1. Create an account on [Crowdin Enterprise](https://localizethedocs.crowdin.com/u/signup) if you don’t have one.
2. Log in and go the [vtk-docs-l10n](https://localizethedocs.crowdin.com/vtk-docs-l10n) project.
3. Choose the language you would like to contribute.

If translators want to translate a language that is not yet supported, they just need to open a new [issue](https://github.com/localizethedocs/vtk-docs-l10n/issues/new?template=language_request.yml) to request the new language. Once the requested language is added, they can begin translating.

## How to Reuse Translations?

If the upstream project or anyone wants to reuse the translated `.po` files prepared by the `vtk-docs-l10n` project, they can clone the `.po` files from the `po/${VERSION}` branch by using the following command:

```bash
git clone --depth=1 --branch=po/${VERSION} https://github.com/localizethedocs/vtk-docs-l10n.git Documentation/docs/locale

```

Those `po/${VERSION}` branches are created to facilitate reusage by the upstream project. For instance, the `zh_TW` documentation for the `latest` version can be generated using the commands below:

```bash
BRANCH=master
VERSION=latest
LANGUAGE=zh_TW
BUILDER=html

# Prepare the repository and environment
git clone --branch=${BRANCH} --depth=1 https://github.com/Kitware/VTK.git vtk-docs
cd vtk-docs
conda create --prefix ./.conda --yes
conda activate ./.conda
conda install python=3.12 graphviz -c conda-forge -c nodefaults --yes
export PYTHONNOUSERSITE=1
pip install -r Documentation/docs/requirements.txt

# Clone the .po files to the 'locale' directory
git clone --branch=po/${VERSION} --depth=1 https://github.com/localizethedocs/vtk-docs-l10n.git Documentation/docs/locale

# Build the documentation
sphinx-build \
    -b ${BUILDER} \
    -D language=${LANGUAGE} \
    -D locale_dirs=locale \
    -D gettext_compact=0 \
    -D gettext_additional_targets=index,literal-block,raw \
    Documentation/docs \
    Documentation/docs/_build/${LANGUAGE}

# Preview the documentation
firefox Documentation/docs/_build/${LANGUAGE}/index.html

```

If you have questions about this project, feel free to propose here.

---

<div class="post-metadata">

### Author: ![mwestphal](https://discourse.vtk.org/user_avatar/discourse.vtk.org/mwestphal/32/19_2.png) [@mwestphal](https://discourse.vtk.org/u/mwestphal)
#### Post date: [March 16, 2026, 8:43am UTC](https://discourse.vtk.org/t/localization-of-vtk-documentation/16328/2 "2026-03-16T08:43:14Z")

</div>



---

<div class="post-metadata">

### Author: ![system](https://discourse.vtk.org/uploads/default/original/1X/b7d45ff6520965c4fbd148f8d0b1f7720956fa24.png) [@system](https://discourse.vtk.org/u/system)
#### Post date: [March 16, 2026, 9:10am UTC](https://discourse.vtk.org/t/localization-of-vtk-documentation/16328/3 "2026-03-16T09:10:50Z")

</div>



---

<div class="post-metadata">

### Author: ![mwestphal](https://discourse.vtk.org/user_avatar/discourse.vtk.org/mwestphal/32/19_2.png) [@mwestphal](https://discourse.vtk.org/u/mwestphal)
#### Post date: [March 16, 2026, 9:15am UTC](https://discourse.vtk.org/t/localization-of-vtk-documentation/16328/4 "2026-03-16T09:15:21Z")

</div>



---

<div class="post-metadata">

### Author: ![mwestphal](https://discourse.vtk.org/user_avatar/discourse.vtk.org/mwestphal/32/19_2.png) [@mwestphal](https://discourse.vtk.org/u/mwestphal)
#### Post date: [March 16, 2026, 9:15am UTC](https://discourse.vtk.org/t/localization-of-vtk-documentation/16328/5 "2026-03-16T09:15:35Z")

</div>



---

<div class="post-metadata">

### Author: ![mwestphal](https://discourse.vtk.org/user_avatar/discourse.vtk.org/mwestphal/32/19_2.png) [@mwestphal](https://discourse.vtk.org/u/mwestphal)
#### Post date: [March 16, 2026, 1:32pm UTC](https://discourse.vtk.org/t/localization-of-vtk-documentation/16328/6 "2026-03-16T13:32:20Z")

</div>



---

<div class="post-metadata">

### Author: ![mwestphal](https://discourse.vtk.org/user_avatar/discourse.vtk.org/mwestphal/32/19_2.png) [@mwestphal](https://discourse.vtk.org/u/mwestphal)
#### Post date: [March 16, 2026, 1:32pm UTC](https://discourse.vtk.org/t/localization-of-vtk-documentation/16328/7 "2026-03-16T13:32:23Z")

</div>


