-
-
Notifications
You must be signed in to change notification settings - Fork 151
Open
Labels
docsImprovements or additions to documentationImprovements or additions to documentationdxfeaturehelp wantedExtra attention is neededExtra attention is neededp3-significantHigh-priority enhancement (priority)High-priority enhancement (priority)
Description
Description
As a developer using TresJS I would like to have documentation available in my native language
This ticket is meant to keep track of the progress of multiple PRs to translate Tres docs:
- Enable i18n and add Spanish docs done Add i18n to Tresjs documentation #123 docs: enable multi language #534
- Chinese translations @enpitsuLin docs: chinese translations #550
- German @DennisSmuda docs: german translations #548
- Polish @Dekier docs: polish translation #546
- French @AminGtt docs: french translation #555
Feel free to comment below if you would like to add your language and help us translate the docs.,
Suggested solution
Create a branch docs/translation-<language-unicode>
and a PR similar to #534 with the following steps:
- Add a
<language-unicode>.ts
insidedocs/.vitepress/config
ex:zh.ts
(copy theen.ts
which is the original and then translate only what's needed. - Remember to add the code prefix route to all the links on this file, ex
link: /guide/
->link: /zh/guide
- Add to config to
docs/.vitepress/config/index.ts
like this:
export default defineConfig({
...sharedConfig,
locales: {
root: { label: 'English', lang: 'en-US', link: '/', ...enConfig },
es: { label: 'Español', lang: 'es-ES', link: '/es/', ...esConfig },
/* zh: { label: '简体中文', lang: 'zh-CN', link: '/zh/', ...zhConfig }, */
},
})
- Create a folder with the language code (ex: zh) inside
docs/
, this is where the translations will live, then start translating the files using the same structure as on the docs root, like this:
docs/advanced/extending.md
--> docs/zh/advanced/extending.md
Alternative
No response
Additional context
No response
Validations
- I agree to follow this project's Code of Conduct
- Read the Contributing Guidelines.
- Read the docs.
- Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.
Steve245270533
Metadata
Metadata
Assignees
Labels
docsImprovements or additions to documentationImprovements or additions to documentationdxfeaturehelp wantedExtra attention is neededExtra attention is neededp3-significantHigh-priority enhancement (priority)High-priority enhancement (priority)
Type
Projects
Status
In Progress