diff --git a/docs/plugins/community-plugins.md b/docs/plugins/community-plugins.md index 3726e3ce5..2f720427b 100644 --- a/docs/plugins/community-plugins.md +++ b/docs/plugins/community-plugins.md @@ -1,15 +1,17 @@ # Community Plugins +## Farm Plugins + +- [farm-pulgin-strip](https://github.com/CCherry07/farm-pulgin-strip): A Farm Rust plugin to remove `debugger` statements and functions like `assert.equal` and `console.log` from your code. + +## Vite/Rollup Plugins + Farm support `Vite/Rollup` plugins out of box. So `Vite/Rollup` or `unplugin` plugins can be used in Farm directly. :::tip Farm recommends to write Farm Plugins instead of `Vite/Rollup` plugins for Farm. Because Farm Plugins have the best compatibility and performance. Still, PR welcome if you developed a Farm compatible plugin and you want to list it here. ::: -Current tested compatible `Vite/Rollup/unplugin` plugins as below: - -## Vite/Rollup Plugins - using `vitePlugins` in `farm.config.ts` to configure `Vite/Rollup` plugins. ```ts diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/plugins/community-plugins.md b/i18n/zh/docusaurus-plugin-content-docs/current/plugins/community-plugins.md index 55416c5ac..0a2841333 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/plugins/community-plugins.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/plugins/community-plugins.md @@ -1,13 +1,17 @@ # 社区插件 -Farm 支持开箱即用的“Vite/Rollup”插件。 所以 `Vite/Rollup` 或者 `unplugin` 插件可以直接在 Farm 中使用。 + +## Farm Plugins + +- [farm-pulgin-strip](https://github.com/CCherry07/farm-pulgin-strip): 一个 Farm Rust 插件,用于从代码中删除 debugger 语句和函数,例如 assert.equal 和 console.log 。 + +## Vite/Rollup Plugins + +Farm支持 `Vite/Rollup` 插件开箱即用。所以`Vite/Rollup`或`unplugin`插件可以直接在Farm中使用。 :::tip 如果您开发了兼容 Farm 的插件并且想在此处列出,欢迎 PR。 ::: -目前测试兼容的`Vite/Rollup/unplugin`插件如下: - -## Vite/Rollup Plugins 使用 `farm.config.ts` 中的 `vitePlugins` 来配置 `Vite/Rollup` 插件。 ```ts @@ -23,13 +27,14 @@ const config: UserConfig = { } ``` -* **[`@vitejs/plugin-vue`](https://github.com/vitejs/vite-plugin-vue/blob/main/packages/plugin-vue/README.md)**: Vue 支持. -* **[`@vitejs/plugin-vue-jsx`](https://github.com/vitejs/vite-plugin-vue/tree/main/packages/plugin-vue-jsx)**: Vue Jsx/Tsx 支持. -* **[`vite-plugin-solid`](https://www.npmjs.com/package/vite-plugin-solid)**: Solid 支持 -* **[`vite-plugin-mock`](https://www.npmjs.com/package/vite-plugin-solid)**: Mock 数据. -* ... +- **[`@vitejs/plugin-vue`](https://github.com/vitejs/vite-plugin-vue/blob/main/packages/plugin-vue/README.md)**: Vue 支持. +- **[`@vitejs/plugin-vue-jsx`](https://github.com/vitejs/vite-plugin-vue/tree/main/packages/plugin-vue-jsx)**: Vue Jsx/Tsx 支持. +- **[`vite-plugin-solid`](https://www.npmjs.com/package/vite-plugin-solid)**: Solid 支持 +- **[`vite-plugin-mock`](https://www.npmjs.com/package/vite-plugin-solid)**: Mock 数据. +- ... ## unplugin + :::note 目前,您可以在 Farm 中使用“unplugin/vite”进行“unplugin/rollup”。 当[此 PR](https://github.com/unjs/unplugin/pull/341) 合并到 unplugin 时,`unplugin/farm` 将可用。 ::: @@ -66,6 +71,7 @@ const config: UserConfig = { ``` Farm 支持所有 unplugin 插件: + - [unplugin-auto-import](https://github.com/antfu/unplugin-auto-import) - [unplugin-vue2-script-setup](https://github.com/antfu/unplugin-vue2-script-setup) - [unplugin-icons](https://github.com/antfu/unplugin-icons) @@ -89,4 +95,4 @@ Farm 支持所有 unplugin 插件: - [unplugin-fonts](https://github.com/cssninjaStudio/unplugin-fonts) - [sentry-javascript-bundler-plugins](https://github.com/getsentry/sentry-javascript-bundler-plugins) - [unplugin-svg-component](https://github.com/Jevon617/unplugin-svg-component) -- [unplugin-vue-cssvars](https://github.com/baiwusanyu-c/unplugin-vue-cssvars) \ No newline at end of file +- [unplugin-vue-cssvars](https://github.com/baiwusanyu-c/unplugin-vue-cssvars) diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/quick-start.mdx b/i18n/zh/docusaurus-plugin-content-docs/current/quick-start.mdx index 27f565bcc..f1c7f5b09 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/quick-start.mdx +++ b/i18n/zh/docusaurus-plugin-content-docs/current/quick-start.mdx @@ -56,7 +56,6 @@ Farm 需要 **Node 16.18.0 及更高版本**。 ## 2.启动项目 选择您喜欢的包管理器,安装依赖项,然后启动项目。 -然后,启动项目: <> diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-0.x/quick-start.mdx b/i18n/zh/docusaurus-plugin-content-docs/version-0.x/quick-start.mdx index 36df1f136..1d003ae93 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-0.x/quick-start.mdx +++ b/i18n/zh/docusaurus-plugin-content-docs/version-0.x/quick-start.mdx @@ -55,8 +55,7 @@ Farm 需要 **Node 16 及以上**。 ## 2.启动项目 -选择您喜欢的包管理器,然后依赖项将自动安装。 -然后,启动项目: +选择您喜欢的包管理器,安装依赖项,然后启动项目。 <>