From e27371269e4c6f89f62e4d0cacc58eb9ce987c19 Mon Sep 17 00:00:00 2001 From: leejooy96 Date: Tue, 24 Dec 2024 10:00:32 +0900 Subject: [PATCH] docs: add introduction page --- docs/src/.vitepress/config.mts | 7 ++++--- docs/src/en/introduction.md | 21 +++++++++++++++++++++ docs/src/ko/introduction.md | 21 +++++++++++++++++++++ 3 files changed, 46 insertions(+), 3 deletions(-) create mode 100644 docs/src/en/introduction.md create mode 100644 docs/src/ko/introduction.md diff --git a/docs/src/.vitepress/config.mts b/docs/src/.vitepress/config.mts index 791b3e4..1e7086e 100644 --- a/docs/src/.vitepress/config.mts +++ b/docs/src/.vitepress/config.mts @@ -1,13 +1,13 @@ import { withSidebar } from 'vitepress-sidebar' -import type { VitePressSidebarOptions } from 'vitepress-sidebar/types' import { name, repository, homepage } from '../../../package.json' import { defineConfig, UserConfig } from 'vitepress' import { withI18n } from 'vitepress-i18n' +import type { VitePressSidebarOptions } from 'vitepress-sidebar/types' import type { VitePressI18nOptions } from 'vitepress-i18n/types' const capitalizeFirst = (str: string): string => str.charAt(0).toUpperCase() + str.slice(1) -const defaultLocale: string = 'en' -const supportLocales = [defaultLocale, 'ko'] +const supportLocales = ['en', 'ko'] +const defaultLocale: string = supportLocales[0] const vitePressI18nConfigs: VitePressI18nOptions = { locales: supportLocales, @@ -48,6 +48,7 @@ const vitePressSidebarConfigs: VitePressSidebarOptions = [ hyphenToSpace: true, capitalizeEachWords: true, manualSortFileNameByPriority: [ + 'introduction.md', 'installation-and-build', 'project-structures', 'electron-how-to' diff --git a/docs/src/en/introduction.md b/docs/src/en/introduction.md new file mode 100644 index 0000000..25c6bea --- /dev/null +++ b/docs/src/en/introduction.md @@ -0,0 +1,21 @@ +# Introduction + +**Vutron** is a preconfigured template for developing `Electron` cross-platform desktop apps. It uses `Vue 3` and allows you to build a fast development environment with little effort. + +## Advantages of use + +- ✅ You can build immediately without any presets, so you can develop quickly. +- ✅ It is being maintained quickly to be compatible with the latest `Vue` and `Electron`, as well as many modules. +- ✅ There is no need to worry about layout and data management by using various additional templates. + +## Features + +- ⚡️ Rapid development through hot-reload +- ⚡️ Cross-platform development and build support +- ⚡️ Support for automated application testing +- ⚡️ TypeScript support +- ⚡️ Multilingual support +- ⚡️ Support for themes (dark & light) +- ⚡️ Basic layout manager +- ⚡️ Global state management through the Pinia store +- ⚡️ Quick support through the GitHub community and official documentation diff --git a/docs/src/ko/introduction.md b/docs/src/ko/introduction.md new file mode 100644 index 0000000..0335e35 --- /dev/null +++ b/docs/src/ko/introduction.md @@ -0,0 +1,21 @@ +# Introduction + +**Vutron** 템플릿은 `Electron`으로 사전 설정 된 크로스 플랫폼 데스크톱 앱입니다. 이 프로젝트는 `Vue 3`을 사용하여 적은 노력으로 빠른 빌드를 가능하게 해줍니다. + +## 사용상의 이점 + +- ✅ 복잡한 사전 설정 없이도 즉시 빌드할 수 있어 빠른 프로젝트 개발이 가능합니다. +- ✅ 최신 `Vue`와 `Electron` 및 여러 모듈에 대해 신속하게 대응하여 유지 관리되고 있습니다. +- ✅ 레이아웃, 데이터 상태 관리와 같은 다양한 사전 구성에 대해 걱정할 필요가 없습니다. + +## 주요 기능 + +- ⚡️ 핫 리로드 기능을 통한 빠른 개발 +- ⚡️ 크로스 플랫폼 개발 및 빌드 지원 +- ⚡️ 자동화된 GUI 테스팅 지원 +- ⚡️ TypeScript 지원 +- ⚡️ 다국어 지원 +- ⚡️ 테마 지원 (다크 & 라이트) +- ⚡️ 기본적인 레이아웃 관리 +- ⚡️ Pinia 스토어를 활용한 글로벌 상태 관리 +- ⚡️ GitHub 커뮤니티와 공식 문서를 통한 프로젝트 기술지원