From 780ddcff2c87642435f6e06ba6a12ea5fdb7cb54 Mon Sep 17 00:00:00 2001 From: Flyme <40132433+Y80@users.noreply.github.com> Date: Wed, 8 Sep 2021 17:39:54 +0800 Subject: [PATCH] docs: unify project name (#4876) Co-authored-by: de_yi --- docs/config/index.md | 4 ++-- docs/guide/api-javascript.md | 4 ++-- docs/guide/build.md | 2 +- docs/guide/index.md | 2 +- docs/guide/ssr.md | 6 +++--- 5 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/config/index.md b/docs/config/index.md index 5cd1a23774400c..dc8bcac1ce221e 100644 --- a/docs/config/index.md +++ b/docs/config/index.md @@ -487,7 +487,7 @@ const { createServer: createViteServer } = require('vite') async function createServer() { const app = express() - // Create vite server in middleware mode. + // Create Vite server in middleware mode. const vite = await createViteServer({ server: { middlewareMode: 'ssr' } }) @@ -704,7 +704,7 @@ createServer() By default, Vite will crawl your index.html to detect dependencies that need to be pre-bundled. If build.rollupOptions.input is specified, Vite will crawl those entry points instead. - If neither of these fit your needs, you can specify custom entries using this option - the value should be a [fast-glob pattern](https://github.com/mrmlnc/fast-glob#basic-syntax) or array of patterns that are relative from vite project root. This will overwrite default entries inference. + If neither of these fit your needs, you can specify custom entries using this option - the value should be a [fast-glob pattern](https://github.com/mrmlnc/fast-glob#basic-syntax) or array of patterns that are relative from Vite project root. This will overwrite default entries inference. ### optimizeDeps.exclude diff --git a/docs/guide/api-javascript.md b/docs/guide/api-javascript.md index e93d5ca5bd8f97..88186f49f6fdb3 100644 --- a/docs/guide/api-javascript.md +++ b/docs/guide/api-javascript.md @@ -40,7 +40,7 @@ The `InlineConfig` interface extends `UserConfig` with additional properties: ```ts interface ViteDevServer { /** - * The resolved vite config object. + * The resolved Vite config object. */ config: ResolvedConfig /** @@ -84,7 +84,7 @@ interface ViteDevServer { options?: TransformOptions ): Promise /** - * Apply vite built-in HTML transforms and any plugin HTML transforms. + * Apply Vite built-in HTML transforms and any plugin HTML transforms. */ transformIndexHtml(url: string, html: string): Promise /** diff --git a/docs/guide/build.md b/docs/guide/build.md index ffc02c50d4baca..aac86a237b6819 100644 --- a/docs/guide/build.md +++ b/docs/guide/build.md @@ -4,7 +4,7 @@ When it is time to deploy your app for production, simply run the `vite build` c ## Browser Compatibility -The production bundle assumes support for modern JavaScript. By default, vite targets browsers which support the [native ESM script tag](https://caniuse.com/es6-module) and [native ESM dynamic import](https://caniuse.com/es6-module-dynamic-import). As a reference, vite uses this [browserslist](https://github.com/browserslist/browserslist) query: +The production bundle assumes support for modern JavaScript. By default, Vite targets browsers which support the [native ESM script tag](https://caniuse.com/es6-module) and [native ESM dynamic import](https://caniuse.com/es6-module-dynamic-import). As a reference, Vite uses this [browserslist](https://github.com/browserslist/browserslist) query: ``` defaults and supports es6-module and supports es6-module-dynamic-import, not opera > 0, not samsung > 0, not and_qq > 0 diff --git a/docs/guide/index.md b/docs/guide/index.md index aad1e2aefcd57f..01b8582323f1cb 100644 --- a/docs/guide/index.md +++ b/docs/guide/index.md @@ -133,7 +133,7 @@ yarn build yarn link ``` -Then go to your vite based project and run `yarn link vite`. Now restart the development server (`yarn dev`) to ride on the bleeding edge! +Then go to your Vite based project and run `yarn link vite`. Now restart the development server (`yarn dev`) to ride on the bleeding edge! ## Community diff --git a/docs/guide/ssr.md b/docs/guide/ssr.md index 3d65723a6bfc58..97a7140c98490e 100644 --- a/docs/guide/ssr.md +++ b/docs/guide/ssr.md @@ -73,7 +73,7 @@ const { createServer: createViteServer } = require('vite') async function createServer() { const app = express() - // Create vite server in middleware mode. This disables Vite's own HTML + // Create Vite server in middleware mode. This disables Vite's own HTML // serving logic and let the parent server take control. // // If you want to use Vite's own HTML serving logic (using Vite as @@ -109,7 +109,7 @@ app.use('*', async (req, res) => { 'utf-8' ) - // 2. Apply vite HTML transforms. This injects the vite HMR client, and + // 2. Apply Vite HTML transforms. This injects the Vite HMR client, and // also applies HTML transforms from Vite plugins, e.g. global preambles // from @vitejs/plugin-react-refresh template = await vite.transformIndexHtml(url, template) @@ -130,7 +130,7 @@ app.use('*', async (req, res) => { // 6. Send the rendered HTML back. res.status(200).set({ 'Content-Type': 'text/html' }).end(html) } catch (e) { - // If an error is caught, let vite fix the stracktrace so it maps back to + // If an error is caught, let Vite fix the stracktrace so it maps back to // your actual source code. vite.ssrFixStacktrace(e) console.error(e)