# mini-electron-guide

**Repository Path**: cybran/mini-electron-guide

## Basic Information

- **Project Name**: mini-electron-guide
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-10-10
- **Last Updated**: 2025-10-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Mini-Electron 指南

## 开始使用

(如果没装 yarn)
```shell
npm install --global yarn
```

第一次使用时：

```shell
yarn
```

开发环境：

```sh
yarn dev
```

打包：

```sh
yarn build
```

打包后的内容位于 `doc\.vitepress\dist`。

打包之后也可以启动一个静态服务查看显示是否正常：

```sh
yarn preview
```

## 编辑须知

修改页面内容直接修改对应的 md 文件即可，页面会自动刷新。

修改其它内容需要编辑配置文件，位置在 `doc\.vitepress\config.js`。

[vitepress 文档在这里]( https://vitepress.vuejs.org/guide/what-is-vitepress )。

编辑内容时尽量注意英文单词与中文用空格隔开(如包括 one 单词，而不是包括one单词)，这样看起来比较舒服。