From af58e3e5ed7c9d21f630ddd7e63dcdc10f4e5be9 Mon Sep 17 00:00:00 2001 From: Erick Zhao Date: Sat, 21 Sep 2024 00:24:56 +0000 Subject: [PATCH] GITBOOK-192: Mark Vite support as experimental --- SUMMARY.md | 4 ++-- config/plugins/vite.md | 6 ++++++ templates/vite-+-typescript.md | 6 ++++++ templates/vite.md | 6 ++++++ 4 files changed, 20 insertions(+), 2 deletions(-) diff --git a/SUMMARY.md b/SUMMARY.md index d0fa39e..c4e577c 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -43,10 +43,10 @@ ## Built-in Templates -* [Vite](templates/vite.md) -* [Vite + TypeScript](templates/vite-+-typescript.md) * [Webpack](templates/webpack-template.md) * [Webpack + Typescript](templates/typescript-+-webpack-template.md) +* [Vite](templates/vite.md) +* [Vite + TypeScript](templates/vite-+-typescript.md) ## Guides diff --git a/config/plugins/vite.md b/config/plugins/vite.md index dd742a1..a9138d0 100644 --- a/config/plugins/vite.md +++ b/config/plugins/vite.md @@ -4,6 +4,12 @@ description: Transform and bundle code for your Electron Forge app with Vite. # Vite Plugin +{% hint style="info" %} +As of Electron Forge v7.5.0, Vite support for Electron Forge has been marked as **experimental** in order to reflect its stage in development and to provide maintainers with the ability to release fixes and improvements rapidly. Future minor releases may contain breaking changes, but migration steps will be listed in release notes.\ +\ +For more context, see the Electron Forge [v7.5.0 release notes](https://github.com/electron/forge/releases/tag/v7.5.0). +{% endhint %} + This plugin makes it easy to set up standard Vite tooling to compile both your main process code and your renderer process code. ## Installation diff --git a/templates/vite-+-typescript.md b/templates/vite-+-typescript.md index 253b72b..5dcd927 100644 --- a/templates/vite-+-typescript.md +++ b/templates/vite-+-typescript.md @@ -1,5 +1,11 @@ # Vite + TypeScript +{% hint style="info" %} +As of Electron Forge v7.5.0, Vite support for Electron Forge has been marked as **experimental** in order to reflect its stage in development and to provide maintainers with the ability to release fixes and improvements rapidly. Future minor releases may contain breaking changes, but migration steps will be listed in release notes.\ +\ +For more context, see the Electron Forge [v7.5.0 release notes](https://github.com/electron/forge/releases/tag/v7.5.0). +{% endhint %} + To get you up and running as fast as possible with [TypeScript](https://www.typescriptlang.org/) and [Vite](https://vitejs.dev/), we provide a template that makes use of the [`@electron-forge/plugin-vite` module](../config/plugins/vite.md) with sane TypeScript configuration defaults. ```bash diff --git a/templates/vite.md b/templates/vite.md index 4aa3fdc..9f17295 100644 --- a/templates/vite.md +++ b/templates/vite.md @@ -4,6 +4,12 @@ description: Create a new Electron app with Vite. # Vite +{% hint style="info" %} +As of Electron Forge v7.5.0, Vite support for Electron Forge has been marked as **experimental** in order to reflect its stage in development and to provide maintainers with the ability to release fixes and improvements rapidly. Future minor releases may contain breaking changes, but migration steps will be listed in release notes.\ +\ +For more context, see the Electron Forge [v7.5.0 release notes](https://github.com/electron/forge/releases/tag/v7.5.0). +{% endhint %} + To get you up and running as fast as possible with [Vite](https://vitejs.dev/), we provide a template that makes use of the [`@electron-forge/plugin-vite` module](../config/plugins/vite.md), plus some preset Vite configuration options. ```bash