Electron Markdown 编辑器教程项目文档

1. 项目的目录结构及介绍

项目的目录结构如下：

electron-markdown-editor-tutorial/
├── packages/
│   ├── main/
│   ├── preload/
│   └── renderer/
├── public/
├── src/
├── .gitignore
├── .npmrc
├── .prettierrc
├── package.json
├── README.md
├── tsconfig.json
└── vite.config.ts

目录结构介绍

• packages/main/: Electron 主进程脚本。
• packages/preload/: 用于 BrowserWindow 的 webPreferences 预加载脚本。
• packages/renderer/: 渲染进程的代码，通常包含 React 组件和 TypeScript 代码。
• public/: 公共资源文件夹，包含一些静态资源。
• src/: 源代码文件夹，通常包含项目的核心代码。
• .gitignore: Git 忽略文件配置。
• .npmrc: npm 配置文件。
• .prettierrc: Prettier 代码格式化配置。
• package.json: 项目依赖和脚本配置。
• README.md: 项目说明文档。
• tsconfig.json: TypeScript 配置文件。
• vite.config.ts: Vite 构建工具配置文件。

2. 项目的启动文件介绍

项目的启动文件主要位于 packages/main/ 目录下，通常包含以下文件：

• index.ts: 主进程入口文件，负责启动 Electron 应用和创建窗口。

启动文件介绍

• index.ts: 该文件是 Electron 应用的主入口点，负责初始化应用、创建主窗口并加载渲染进程的代码。

3. 项目的配置文件介绍

项目的配置文件主要包括以下几个：

• package.json: 项目依赖和脚本配置。
• tsconfig.json: TypeScript 配置文件。
• vite.config.ts: Vite 构建工具配置文件。

配置文件介绍

• package.json: 该文件定义了项目的依赖包、脚本命令和其他元数据。例如，npm run watch 命令用于启动开发服务器。
• tsconfig.json: 该文件包含了 TypeScript 编译器的配置选项，如编译目标、模块解析策略等。
• vite.config.ts: 该文件是 Vite 构建工具的配置文件，定义了项目构建和开发服务器的相关配置。

以上是 Electron Markdown 编辑器教程项目的基本文档，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用该项目。