Skip to content

Commit

Permalink
feat: rename generateI18n function to withI18n
Browse files Browse the repository at this point in the history
  • Loading branch information
@jooy2
jooy2 committed Oct 24, 2024
1 parent 3b17351 commit 4fb24d4
Show file tree
Hide file tree
Showing 17 changed files with 195 additions and 91 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,19 @@
# Changelog

## 1.2.0 (2024-10-24)

- **BREAKING CHANGES**: The `generateI18nLocale` and `generateI18nSearch` functions have now been merged into `withI18n`. Therefore, both functions will be removed in the next version. Please refer to the documentation to migrate to the `withI18n` function.

## 1.1.1 (2024-10-23)

This version is deprecated and not recommended for production use.

- Fix chinese simplified string (#1)

## 1.1.0 (2024-10-23)

This version is deprecated and not recommended for production use.

- **BREAKING CHANGES**: The `generateI18nLocale` and `generateI18nSearch` functions have now been merged into `generateI18n`. Therefore, both functions will be removed in the next version. Please refer to the documentation to migrate to the `generateI18n` function.

## 1.0.6 (2024-09-16)
Expand Down
18 changes: 10 additions & 8 deletions docs/.vitepress/config.ts
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
import { generateSidebar, VitePressSidebarOptions } from 'vitepress-sidebar';
import { repository, homepage } from '../../package.json';
import { defineConfig, UserConfig } from 'vitepress';
import { generateI18n } from '../../dist';
import { withI18n } from '../../dist';
import { VitePressI18nOptions } from '../../dist/types';

const defaultLocale: string = 'en';
const editLinkPattern = `${repository.url}/edit/master/docs/:path`;
Expand All @@ -23,13 +24,14 @@ const defineSupportLocales = [
{ label: 'ko', translateLocale: 'ko' }
];

const vitePressI18nConfig: VitePressI18nOptions = {
defineLocales: defineSupportLocales,
rootLocale: defaultLocale,
editLinkPattern: editLinkPattern,
searchProvider: 'local'
};

const vitePressConfig: UserConfig = {
...generateI18n({
defineLocales: defineSupportLocales,
rootLocale: defaultLocale,
editLinkPattern: editLinkPattern,
searchProvider: 'local'
}),
title: 'VitePress I18n',
lastUpdated: true,
outDir: '../docs-dist',
Expand Down Expand Up @@ -69,4 +71,4 @@ const vitePressConfig: UserConfig = {
}
};

export default defineConfig(vitePressConfig);
export default defineConfig(withI18n(vitePressConfig, vitePressI18nConfig));
44 changes: 27 additions & 17 deletions docs/en/guide/getting-started.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,22 +31,24 @@ $ pnpm i -D vitepress-i18n

먼저 아래 두 가지 방법 중 하나로 `vitepress-i18n`을 import합니다.

### 1. named-import 사용
### 1. named-import 사용 (권장)

```javascript
// `.vitepress/config.js`
import { generateI18n } from 'vitepress-i18n';

const vitepressI18nOptions = {
/* Options... */
};

export default defineConfig({
...generateI18n(vitepressI18nOptions), // <-- Add this
const vitePressOptions = {
title: 'VitePress',
themeConfig: {
// ...
}
});
};

const vitePressI18nOptions = {
/* Options... */
};

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

### 2. default-import 사용
Expand All @@ -55,18 +57,26 @@ export default defineConfig({
// `.vitepress/config.js`
import VitePressI18n from 'vitepress-i18n';

const vitepressI18nOptions = {
/* Options... */
};

export default defineConfig({
...VitePressI18n.generateI18n(vitepressI18nOptions), // <-- Add this
const vitePressOptions = {
title: 'VitePress',
themeConfig: {
// ...
}
});
};

const vitePressI18nOptions = {
/* Options... */
};

export default defineConfig(VitePressI18n.withI18n(vitePressOptions, vitePressI18nOptions));
```

VitePress의 구성 파일인 `.vitepress/config.js` 파일(설정 파일 이름은 프로젝트 환경에 따라 다를 수 있음)의 `defineConfig`의 옵션값의 최상단에 `generateI18n` 메서드를 호출합니다.
VitePress의 구성 파일인 `.vitepress/config.js` 파일(설정 파일 이름은 프로젝트 환경에 따라 다를 수 있음)의 `defineConfig` 옵션값에 `withI18n`을 호출합니다.

`withI18n`에는 두가지 인자값을 포함해야 합니다. 첫번째 인자는 VitePress의 옵션 값을, 두번째 인자는 오버라이딩 할 VitePress I18n의 옵션 값을 포함합니다.

VitePress I18n의 출력 결과에는 자동 번역이 된 텍스트가 포함되어 있습니다. 이 옵션 데이터는 기존의 VitePress의 옵션과 병합 될 것입니다.

이것이 어떻게 출력되는지 테스트하려면 VitePress I18에서 제공하는 `debugPrint` 옵션을 `true`로 설정하여 VitePress를 빌드해 보세요. 콘솔에 출력이 표시될 것입니다.

이것이 어떻게 출력되는지 테스트하려면 `debugPrint` 옵션을 `true`로 설정하여 VitePress를 빌드해 보세요. 콘솔에 출력이 표시될 것입니다.
VitePress I18n의 옵션에 대해 자세히 알아보시려면 VitePress I18n 옵션 문서를 참고하세요.
7 changes: 7 additions & 0 deletions docs/en/guide/options.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
order: 2
---

# Options

This page describes all the options in the VitePress I18n.
4 changes: 2 additions & 2 deletions docs/en/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ hero:
text: GitHub
link: https://github.com/jooy2/vitepress-i18n
image:
src: /sidebar.png
alt: Sidebar
src: /language.png
alt: Language

features:
- icon: <svg width="48" height="48" viewBox="0 0 48 48" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M5.03628 7.87818C4.75336 5.83955 6.15592 3.95466 8.16899 3.66815L33.6838 0.0367403C35.6969 -0.24977 37.5581 1.1706 37.841 3.20923L42.9637 40.1218C43.2466 42.1604 41.8441 44.0453 39.831 44.3319L14.3162 47.9633C12.3031 48.2498 10.4419 46.8294 10.159 44.7908L5.03628 7.87818Z" fill="url(#paint0_linear_1287_1214)"/><path d="M6.85877 7.6188C6.71731 6.59948 7.41859 5.65703 8.42512 5.51378L33.9399 1.88237C34.9465 1.73911 35.8771 2.4493 36.0186 3.46861L41.1412 40.3812C41.2827 41.4005 40.5814 42.343 39.5749 42.4862L14.0601 46.1176C13.0535 46.2609 12.1229 45.5507 11.9814 44.5314L6.85877 7.6188Z" fill="white"/><path d="M33.1857 14.9195L25.8505 34.1576C25.6991 34.5547 25.1763 34.63 24.9177 34.2919L12.3343 17.8339C12.0526 17.4655 12.3217 16.9339 12.7806 16.9524L22.9053 17.3607C22.9698 17.3633 23.0344 17.3541 23.0956 17.3337L32.5088 14.1992C32.9431 14.0546 33.3503 14.4878 33.1857 14.9195Z" fill="url(#paint1_linear_1287_1214)"/><path d="M27.0251 12.5756L19.9352 15.0427C19.8187 15.0832 19.7444 15.1986 19.7546 15.3231L20.3916 23.063C20.4066 23.2453 20.5904 23.3628 20.7588 23.2977L22.7226 22.5392C22.9064 22.4682 23.1021 22.6138 23.0905 22.8128L22.9102 25.8903C22.8982 26.0974 23.1093 26.2436 23.295 26.1567L24.4948 25.5953C24.6808 25.5084 24.892 25.6549 24.8795 25.8624L24.5855 30.6979C24.5671 31.0004 24.9759 31.1067 25.1013 30.8321L25.185 30.6487L29.4298 17.8014C29.5008 17.5863 29.2968 17.3809 29.0847 17.454L27.0519 18.1547C26.8609 18.2205 26.6675 18.0586 26.6954 17.8561L27.3823 12.8739C27.4103 12.6712 27.2163 12.5091 27.0251 12.5756Z" fill="url(#paint2_linear_1287_1214)"/><defs><linearGradient id="paint0_linear_1287_1214" x1="6.48163" y1="1.9759" x2="39.05" y2="48.2064" gradientUnits="userSpaceOnUse"><stop stop-color="#49C7FF"/><stop offset="1" stop-color="#BD36FF"/></linearGradient><linearGradient id="paint1_linear_1287_1214" x1="11.8848" y1="16.4266" x2="26.7246" y2="31.4177" gradientUnits="userSpaceOnUse"><stop stop-color="#41D1FF"/><stop offset="1" stop-color="#BD34FE"/></linearGradient><linearGradient id="paint2_linear_1287_1214" x1="21.8138" y1="13.7046" x2="26.2464" y2="28.8069" gradientUnits="userSpaceOnUse"><stop stop-color="#FFEA83"/><stop offset="0.0833333" stop-color="#FFDD35"/><stop offset="1" stop-color="#FFA800"/></linearGradient></defs></svg>
Expand Down
44 changes: 27 additions & 17 deletions docs/ko/guide/getting-started.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,22 +31,24 @@ $ pnpm i -D vitepress-i18n

먼저 아래 두 가지 방법 중 하나로 `vitepress-i18n`을 import합니다.

### 1. named-import 사용
### 1. named-import 사용 (권장)

```javascript
// `.vitepress/config.js`
import { generateI18n } from 'vitepress-i18n';

const vitepressI18nOptions = {
/* Options... */
};

export default defineConfig({
...generateI18n(vitepressI18nOptions), // <-- Add this
const vitePressOptions = {
title: 'VitePress',
themeConfig: {
// ...
}
});
};

const vitePressI18nOptions = {
/* Options... */
};

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

### 2. default-import 사용
Expand All @@ -55,18 +57,26 @@ export default defineConfig({
// `.vitepress/config.js`
import VitePressI18n from 'vitepress-i18n';

const vitepressI18nOptions = {
/* Options... */
};

export default defineConfig({
...VitePressI18n.generateI18n(vitepressI18nOptions), // <-- Add this
const vitePressOptions = {
title: 'VitePress',
themeConfig: {
// ...
}
});
};

const vitePressI18nOptions = {
/* Options... */
};

export default defineConfig(VitePressI18n.withI18n(vitePressOptions, vitePressI18nOptions));
```

VitePress의 구성 파일인 `.vitepress/config.js` 파일(설정 파일 이름은 프로젝트 환경에 따라 다를 수 있음)의 `defineConfig`의 옵션값의 최상단에 `generateI18n` 메서드를 호출합니다.
VitePress의 구성 파일인 `.vitepress/config.js` 파일(설정 파일 이름은 프로젝트 환경에 따라 다를 수 있음)의 `defineConfig` 옵션값에 `withI18n`을 호출합니다.

`withI18n`에는 두가지 인자값을 포함해야 합니다. 첫번째 인자는 VitePress의 옵션 값을, 두번째 인자는 오버라이딩 할 VitePress I18n의 옵션 값을 포함합니다.

VitePress I18n의 출력 결과에는 자동 번역이 된 텍스트가 포함되어 있습니다. 이 옵션 데이터는 기존의 VitePress의 옵션과 병합 될 것입니다.

이것이 어떻게 출력되는지 테스트하려면 VitePress I18에서 제공하는 `debugPrint` 옵션을 `true`로 설정하여 VitePress를 빌드해 보세요. 콘솔에 출력이 표시될 것입니다.

이것이 어떻게 출력되는지 테스트하려면 `debugPrint` 옵션을 `true`로 설정하여 VitePress를 빌드해 보세요. 콘솔에 출력이 표시될 것입니다.
VitePress I18n의 옵션에 대해 자세히 알아보시려면 VitePress I18n 옵션 문서를 참고하세요.
7 changes: 7 additions & 0 deletions docs/ko/guide/options.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
order: 2
---

# 옵션

이 페이지에서는 VitePress I18n의 모든 옵션에 대해 설명합니다.
12 changes: 6 additions & 6 deletions docs/ko/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ hero:
text: GitHub
link: https://github.com/jooy2/vitepress-i18n
image:
src: /sidebar.png
alt: Sidebar
src: /language.png
alt: Language

features:
- icon: <svg width="48" height="48" viewBox="0 0 48 48" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M5.03628 7.87818C4.75336 5.83955 6.15592 3.95466 8.16899 3.66815L33.6838 0.0367403C35.6969 -0.24977 37.5581 1.1706 37.841 3.20923L42.9637 40.1218C43.2466 42.1604 41.8441 44.0453 39.831 44.3319L14.3162 47.9633C12.3031 48.2498 10.4419 46.8294 10.159 44.7908L5.03628 7.87818Z" fill="url(#paint0_linear_1287_1214)"/><path d="M6.85877 7.6188C6.71731 6.59948 7.41859 5.65703 8.42512 5.51378L33.9399 1.88237C34.9465 1.73911 35.8771 2.4493 36.0186 3.46861L41.1412 40.3812C41.2827 41.4005 40.5814 42.343 39.5749 42.4862L14.0601 46.1176C13.0535 46.2609 12.1229 45.5507 11.9814 44.5314L6.85877 7.6188Z" fill="white"/><path d="M33.1857 14.9195L25.8505 34.1576C25.6991 34.5547 25.1763 34.63 24.9177 34.2919L12.3343 17.8339C12.0526 17.4655 12.3217 16.9339 12.7806 16.9524L22.9053 17.3607C22.9698 17.3633 23.0344 17.3541 23.0956 17.3337L32.5088 14.1992C32.9431 14.0546 33.3503 14.4878 33.1857 14.9195Z" fill="url(#paint1_linear_1287_1214)"/><path d="M27.0251 12.5756L19.9352 15.0427C19.8187 15.0832 19.7444 15.1986 19.7546 15.3231L20.3916 23.063C20.4066 23.2453 20.5904 23.3628 20.7588 23.2977L22.7226 22.5392C22.9064 22.4682 23.1021 22.6138 23.0905 22.8128L22.9102 25.8903C22.8982 26.0974 23.1093 26.2436 23.295 26.1567L24.4948 25.5953C24.6808 25.5084 24.892 25.6549 24.8795 25.8624L24.5855 30.6979C24.5671 31.0004 24.9759 31.1067 25.1013 30.8321L25.185 30.6487L29.4298 17.8014C29.5008 17.5863 29.2968 17.3809 29.0847 17.454L27.0519 18.1547C26.8609 18.2205 26.6675 18.0586 26.6954 17.8561L27.3823 12.8739C27.4103 12.6712 27.2163 12.5091 27.0251 12.5756Z" fill="url(#paint2_linear_1287_1214)"/><defs><linearGradient id="paint0_linear_1287_1214" x1="6.48163" y1="1.9759" x2="39.05" y2="48.2064" gradientUnits="userSpaceOnUse"><stop stop-color="#49C7FF"/><stop offset="1" stop-color="#BD36FF"/></linearGradient><linearGradient id="paint1_linear_1287_1214" x1="11.8848" y1="16.4266" x2="26.7246" y2="31.4177" gradientUnits="userSpaceOnUse"><stop stop-color="#41D1FF"/><stop offset="1" stop-color="#BD34FE"/></linearGradient><linearGradient id="paint2_linear_1287_1214" x1="21.8138" y1="13.7046" x2="26.2464" y2="28.8069" gradientUnits="userSpaceOnUse"><stop stop-color="#FFEA83"/><stop offset="0.0833333" stop-color="#FFDD35"/><stop offset="1" stop-color="#FFA800"/></linearGradient></defs></svg>
Expand All @@ -34,21 +34,21 @@ features:
<style>
:root {
--vp-home-hero-name-color: transparent;
--vp-home-hero-name-background: -webkit-linear-gradient(120deg, #34e8b8 30%, #006cd9);
--vp-home-hero-name-background: -webkit-linear-gradient(-12deg, #4aba85 30%, #044c2d);

--vp-home-hero-image-background-image: linear-gradient(-45deg, #34b8e8 60%, #006cd9 60%);
--vp-home-hero-image-background-image: linear-gradient(-45deg, #8fd6e6 60%, #5fb4ca 60%);
--vp-home-hero-image-filter: blur(20px);
}

@media (min-width: 640px) {
:root {
--vp-home-hero-image-filter: blur(35px);
--vp-home-hero-image-filter: blur(45px);
}
}

@media (min-width: 960px) {
:root {
--vp-home-hero-image-filter: blur(40px);
--vp-home-hero-image-filter: blur(30px);
}
}
</style>
8 changes: 4 additions & 4 deletions docs/ko/introduction.md
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# 소개

**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.
**VitePress I18n**은 기본 테마와 검색 도구에서 텍스트를 쉽게 번역할 수 있는 VitePress용 플러그인입니다. 간단한 설정으로 기본 레이아웃을 번역하며 코드 중복 없이 여러 프로젝트에서 사용할 수 있습니다.

- ⚡️ Optimized for the latest version of **VitePress**
- ⚡️ Lightweight bundle file size, zero dependencies
- ⚡️ [TypeScript](https://www.typescriptlang.org) support
- ⚡️ 최신 버전의 **VitePress**에 최적화되었습니다.
- ⚡️ 가벼운 번들 파일 크기, 제로 종속성
- ⚡️ [TypeScript](https://www.typescriptlang.org) 지원

## 어디에서 사용되나요?

Expand Down
Binary file modified docs/public/favicon.ico
View file
Binary file not shown.
Binary file added docs/public/language.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/public/logo-16.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/public/logo-32.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/public/sidebar.png
View file
Binary file not shown.
Loading

0 comments on commit 4fb24d4

Please sign in to comment.