docs: add introduction page

This commit is contained in:
leejooy96 committed 2024-12-24 10:00:32 +09:00
1 parent df829d199c
commit e27371269e
3 files changed
+46 -3

No files matched your search

+4 -3
View File
@@ -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'
+21
View File
@@ -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
+21
View File
@@ -0,0 +1,21 @@
# Introduction
**Vutron** 템플릿은 `Electron`으로 사전 설정 된 크로스 플랫폼 데스크톱 앱입니다. 이 프로젝트는 `Vue 3`을 사용하여 적은 노력으로 빠른 빌드를 가능하게 해줍니다.
## 사용상의 이점
- ✅ 복잡한 사전 설정 없이도 즉시 빌드할 수 있어 빠른 프로젝트 개발이 가능합니다.
- ✅ 최신 `Vue`와 `Electron` 및 여러 모듈에 대해 신속하게 대응하여 유지 관리되고 있습니다.
- ✅ 레이아웃, 데이터 상태 관리와 같은 다양한 사전 구성에 대해 걱정할 필요가 없습니다.
## 주요 기능
- ⚡️ 핫 리로드 기능을 통한 빠른 개발
- ⚡️ 크로스 플랫폼 개발 및 빌드 지원
- ⚡️ 자동화된 GUI 테스팅 지원
- ⚡️ TypeScript 지원
- ⚡️ 다국어 지원
- ⚡️ 테마 지원 (다크 & 라이트)
- ⚡️ 기본적인 레이아웃 관리
- ⚡️ Pinia 스토어를 활용한 글로벌 상태 관리
- ⚡️ GitHub 커뮤니티와 공식 문서를 통한 프로젝트 기술지원