Inkdown 项目教程

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

Inkdown 项目的目录结构如下：

inkdown/
├── electron-builder.yml
├── electron-vite.config.ts
├── package.json
├── pnpm-lock.yaml
├── postcss.config.js
├── tailwind.config.js
├── tsconfig.json
├── tsconfig.node.json
├── tsconfig.web.json
├── README.md
├── LICENSE
├── src/
│   ├── main.ts
│   ├── renderer.ts
│   ├── ...
├── public/
│   ├── index.html
│   ├── ...
├── dist/
│   ├── ...
├── ...

目录结构介绍

• electron-builder.yml: Electron 构建配置文件。
• electron-vite.config.ts: Vite 配置文件，用于 Electron 项目。
• package.json: 项目的包管理文件，包含依赖和脚本。
• pnpm-lock.yaml: pnpm 的锁定文件，确保依赖版本一致。
• postcss.config.js: PostCSS 配置文件，用于 CSS 处理。
• tailwind.config.js: Tailwind CSS 配置文件，用于样式管理。
• tsconfig.json: TypeScript 全局配置文件。
• tsconfig.node.json: TypeScript 配置文件，用于 Node.js 环境。
• tsconfig.web.json: TypeScript 配置文件，用于 Web 环境。
• README.md: 项目说明文件。
• LICENSE: 项目许可证文件。
• src/: 项目源代码目录。
• public/: 静态资源目录。
• dist/: 构建输出目录。

2. 项目的启动文件介绍

Inkdown 项目的主要启动文件包括：

• src/main.ts: 主进程启动文件，负责 Electron 应用的初始化和主窗口的创建。
• src/renderer.ts: 渲染进程启动文件，负责前端页面的渲染和交互。

启动文件介绍

• main.ts: 该文件是 Electron 应用的主入口，负责启动主进程，创建窗口并加载渲染进程。
• renderer.ts: 该文件是渲染进程的入口，负责加载前端页面，处理用户交互和页面渲染。

3. 项目的配置文件介绍

Inkdown 项目的主要配置文件包括：

• electron-builder.yml: Electron 构建配置文件，定义了应用的打包和发布配置。
• electron-vite.config.ts: Vite 配置文件，用于配置开发服务器和构建过程。
• package.json: 项目的包管理文件，定义了项目的依赖、脚本和元数据。
• postcss.config.js: PostCSS 配置文件，用于配置 CSS 预处理器和插件。
• tailwind.config.js: Tailwind CSS 配置文件，用于配置样式生成规则和插件。
• tsconfig.json: TypeScript 全局配置文件，定义了 TypeScript 编译选项。
• tsconfig.node.json: TypeScript 配置文件，用于 Node.js 环境的编译选项。
• tsconfig.web.json: TypeScript 配置文件，用于 Web 环境的编译选项。

配置文件介绍

• electron-builder.yml: 该文件定义了 Electron 应用的打包和发布配置，包括目标平台、输出格式、图标等。
• electron-vite.config.ts: 该文件配置了 Vite 开发服务器和构建过程，包括端口、代理、构建输出目录等。
• package.json: 该文件包含了项目的依赖、脚本和元数据，是项目管理的核心文件。
• postcss.config.js: 该文件配置了 PostCSS 插件和选项，用于处理 CSS 文件。
• tailwind.config.js: 该文件配置了 Tailwind CSS 的样式生成规则和插件，用于生成自定义样式。
• tsconfig.json: 该文件定义了 TypeScript 编译的全局选项，包括目标版本、模块系统、严格模式等。
• tsconfig.node.json: 该文件定义了 TypeScript 编译的 Node.js 环境选项，用于 Node.js 项目的编译。
• tsconfig.web.json: 该文件定义了 TypeScript 编译的 Web 环境选项，用于 Web 项目的编译。