README.md

🔌 VitePress i18n

VitePress i18n is a plugin for VitePress that makes it easy to translate text in the default theme and search tool. It translates the default layout with a simple setup and can be used in multiple projects without duplicate code.

• ⚡️ Optimized for the latest version of VitePress
• ⚡️ Lightweight bundle file size, zero dependencies
• ⚡️ TypeScript support

Documentation (Getting Started & All option lists)

Installing and using the package and defining all the utility methods can be found on the documentation page below: https://vitepress-i18n.cdget.com/guide/getting-started

Supported languages

(* = Currently using machine translation. Help us improve translation quality with a pull request!)

• English: en
• Korean (한국어): ko
• Chinese Simplified (简体中文): zhHans
• * Chinese Traditional (繁體中文): zhHant
• * Japanese (日本語): ja
• Spanish (Español): es
• Portuguese (Português): pt
• Russian (Русский): ru
• * Indonesian (Bahasa Indonesia): id
• * German (Deutsch): de
• * French (Français): fr
• * Vietnamese (Tiếng Việt): vi
• * Italian (Italiano): it

Example

Basic configurations

import { withI18n } from 'vitepress-i18n';

const vitePressOptions = {
  title: 'VitePress',
  themeConfig: {
    // ...
  }
};

const vitePressI18nOptions = {
  locales: ['en', 'ko', 'zhHans']
};

export default defineConfig(withI18n(vitePressOptions, vitePressI18nOptions));

With complex configurations

import { withI18n } from 'vitepress-i18n';

const vitePressOptions = {
  title: 'VitePress',
  themeConfig: {
    // ...
  }
};

const vitePressI18nOptions = {
  locales: [
    { path: 'eng', locale: 'en' },
    { path: 'kor', locale: 'ko' }
  ],
  rootLocale: 'en',
  description: {
    en: 'Hello',
    ko: '안녕하세요'
  }
};

export default defineConfig(withI18n(vitePressOptions, vitePressI18nOptions));

Contributing

Anyone can contribute to the project by reporting new issues or submitting a pull request. For more information, please see CONTRIBUTING.md.

License

Please see the LICENSE file for more information about project owners, usage rights, and more.