https://github.com/jooy2/vitepress-i18n

VitePress i18n is a plugin for VitePress that makes it easy to translate text in the default theme and search tool.
https://github.com/jooy2/vitepress-i18n

i18n internationalization locales locales-translation translate translation vite vitepress vitepress-plugin

Last synced: 22 days ago
JSON representation

VitePress i18n is a plugin for VitePress that makes it easy to translate text in the default theme and search tool.

• Host: GitHub
• URL: https://github.com/jooy2/vitepress-i18n
• Owner: jooy2
• License: mit
• Created: 2024-09-04T11:53:23.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-11-12T01:12:50.000Z (about 1 month ago)
• Last Synced: 2024-11-13T09:08:17.774Z (30 days ago)
• Topics: i18n, internationalization, locales, locales-translation, translate, translation, vite, vitepress, vitepress-plugin
• Language: TypeScript
• Homepage: https://vitepress-i18n.cdget.com
• Size: 1.44 MB
• Stars: 9
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-vitepress-v1 - vitepress-i18n - VitePress i18n is a plugin for VitePress that makes it easy to translate text in the default theme and search tool (:electric_plug: Plugins / Community Plugins)

README

        
# 🔌 VitePress i18n

[![awesome-vitepress](https://awesome.re/mentioned-badge.svg)](https://github.com/logicspark/awesome-vitepress-v1) [![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/jooy2/vitepress-i18n/blob/master/LICENSE) ![Programming Language Usage](https://img.shields.io/github/languages/top/jooy2/vitepress-i18n) ![Commit Count](https://img.shields.io/github/commit-activity/y/jooy2/vitepress-i18n) [![npm downloads](https://img.shields.io/npm/dm/vitepress-i18n.svg)](https://www.npmjs.com/package/vitepress-i18n) [![npm latest package](https://img.shields.io/npm/v/vitepress-i18n/latest.svg)](https://www.npmjs.com/package/vitepress-i18n) ![npm bundle size](https://img.shields.io/bundlephobia/min/vitepress-i18n) [![Followers](https://img.shields.io/github/followers/jooy2?style=social)](https://github.com/jooy2) ![Stars](https://img.shields.io/github/stars/jooy2/vitepress-i18n?style=social)

**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](https://www.typescriptlang.org) support

## [Documentation (Getting Started & All option lists)](https://vitepress-i18n.cdget.com/guide/getting-started)

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

```javascript

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

```javascript

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));

```

## Contribute

You can report issues on [GitHub Issue Tracker](https://github.com/jooy2/vitepress-i18n/issues).

You can also request a pull to fix bugs and add frequently used features.

## License

Copyright © 2024 [CDGet](https://cdget.com) <[[email protected]](mailto:[email protected])> Released under the MIT license.