Translation

[otabekoff]

Discussions about language translations.

[Zhengqbbb]

reference #631

[otabekoff]

I think, this is officially supported for now. But not mentioned in the docs. I add some code like below at themeConfig and it is showing a dropdown for translations. But, I only tested exterenal links.

    localeLinks: {
      text: 'Uzbek',
      items: [
        { text: 'Ўзбекча', link: 'https://oz.waffle.dev' },
        { text: 'English', link: 'https://en.waffle.dev' },
        { text: 'Русский', link: 'https://ru.waffle.dev' }
      ]
    }

Also you should consider adding some code before themeConfig like below.

  locales: {
    '/': {
      lang: 'en-US',
      title: 'envd',
      description: 'AI/ML Development Environment'
    },
    '/zh/': {
      lang: 'zh-CN',
      title: 'envd',
      description: 'AI/ML 开发环境'
    },
  }

And I think it should be added into the docs if it is finished and working.

[otabekoff]

I've a question! Is it possible to translate copyright section in footer?

[otabekoff]

In general, How to translate the navbar, sidebar, footer and all properties?

[brc-dd]

It isn't fully supported yet. I am working on that. You can check the feat/i18n branch if you wish (things are nearly done, testing and docs are left). Its better to track #631 instead.

[otabekoff]

@brc-dd So, does this approach will be correct?

docs\.vitepress\config\nav.js

export const navConfig = {
  '/': [
    { text: 'Qo\'llanma', link: '/qollanma/', },
    { text: 'Komponentlar', link: '/komponentlar/' },
    { text: 'Makrdown yozish', link: '/markdown/' },
   ],
  '/translations/en-us/': [
    { text: 'Guide', link: '/qollanma/', },
    { text: 'Components', link: '/komponentlar/' },
    { text: 'Writing markdown', link: '/markdown/' },
  ]
}

docs\.vitepress\config.js

import { navConfig } from "./config/nav";

...

  locales: {
    '/': {
      lang: 'uz-LAT',
      title: "BuNom",
      description: "Bu yerda biroz tarif."
    },
    'translations/en-us/': {
      lang: 'en-US',
      title: 'TitleHere',
      description: 'Here is some description.'
    }
  }

  ...

  themeConfig: {
    nav: navConfig,
...

[otabekoff]

So, my translations goes in themeConfig > locales > fr > nav ? Is it correct?

[brc-dd]

No, in: locales > fr > themeConfig > nav. locales will be top-level (independent of whatever theme you're using).

[otabekoff]

This part is abstract for me.

      // themeConfig is not merged deeply, so if someone wants to have some common config,
      // they'll need to store it in an object and do themeConfig: {...shared, foo: 'bar'}

QUESTIONS:

1. If I define languages like fr:{...} what should I write in themeConfig.localeLinks? Or does this will automatically happens and we don't need localeLinks?

2. I tried this but didn't work.

// As you tell it is in locales > fr > themeConfig > nav and is top-level.
locales: {
    root: {
      label: "O'zbekcha"
      // I didn't write lang, title and other additionals here but out of the locales.
    },
    enUS: {
      lang: 'en-US',
      title: 'Title here',
      description: 'Description can be here',
      link: 'translations/en-us/',
      themeConfig: {
        nav: [
          { text: 'Guide', link: 'translations/en-us/guide/' },
          { text: 'Components', link: 'translations/en-us/components/' },
          { text: 'Makrdown', link: 'translations/en-us/markdown/' }
        ],
      }
    },
  }

[brc-dd]

I tried this but didn't work.

It should work with our feat/i18n branch, not with the published version. Its still WIP.

what should I write in themeConfig.localeLinks

This is removed.

[otabekoff]

Ok. I will wait for the release. And approximately when are you planning to do this i18n release?