Skip to content

Commit

Permalink
docs(core): move package documents into its own folder (#13935)
Browse files Browse the repository at this point in the history 
Signed-off-by: Ben <3447705+bcabanes@users.noreply.github.com>
  • Loading branch information
@bcabanes
bcabanes committed Dec 20, 2022
1 parent 7beee3c commit ae8e028
Show file tree
Hide file tree
Showing 41 changed files with 118 additions and 118 deletions.
72 changes: 36 additions & 36 deletions docs/generated/manifests/packages.json
View file
Expand Up @@ -26,7 +26,7 @@
"isExternal": false,
"path": "/packages/angular/documents/overview",
"tags": [],
"originalFilePath": "shared/angular-plugin"
"originalFilePath": "shared/packages/angular/angular-plugin"
},
"/packages/angular/documents/angular-nx-version-matrix": {
"id": "angular-nx-version-matrix",
Expand All @@ -37,7 +37,7 @@
"isExternal": false,
"path": "/packages/angular/documents/angular-nx-version-matrix",
"tags": [],
"originalFilePath": "shared/angular-nx-version-matrix"
"originalFilePath": "shared/packages/angular/angular-nx-version-matrix"
}
},
"root": "/packages/angular",
Expand Down Expand Up @@ -468,7 +468,7 @@
"isExternal": false,
"path": "/packages/cypress/documents/overview",
"tags": [],
"originalFilePath": "shared/cypress-plugin"
"originalFilePath": "shared/packages/cypress/cypress-plugin"
},
"/packages/cypress/documents/cypress-component-testing": {
"id": "cypress-component-testing",
Expand All @@ -479,7 +479,7 @@
"isExternal": false,
"path": "/packages/cypress/documents/cypress-component-testing",
"tags": [],
"originalFilePath": "shared/guides/cypress/cypress-component-testing"
"originalFilePath": "shared/packages/cypress/cypress-component-testing"
},
"/packages/cypress/documents/v11-migration-guide": {
"id": "v11-migration-guide",
Expand All @@ -490,7 +490,7 @@
"isExternal": false,
"path": "/packages/cypress/documents/v11-migration-guide",
"tags": [],
"originalFilePath": "shared/guides/cypress/cypress-v11-migration"
"originalFilePath": "shared/packages/cypress/cypress-v11-migration"
}
},
"root": "/packages/cypress",
Expand Down Expand Up @@ -561,7 +561,7 @@
"isExternal": false,
"path": "/packages/detox/documents/overview",
"tags": [],
"originalFilePath": "shared/detox-plugin"
"originalFilePath": "shared/packages/detox/detox-plugin"
}
},
"root": "/packages/detox",
Expand Down Expand Up @@ -658,7 +658,7 @@
"isExternal": false,
"path": "/packages/esbuild/documents/overview",
"tags": [],
"originalFilePath": "shared/esbuild-plugin"
"originalFilePath": "shared/packages/esbuild/esbuild-plugin"
}
},
"root": "/packages/esbuild",
Expand Down Expand Up @@ -711,7 +711,7 @@
"isExternal": false,
"path": "/packages/eslint-plugin-nx/documents/overview",
"tags": [],
"originalFilePath": "shared/eslint-plugin-nx"
"originalFilePath": "shared/packages/linter/eslint-plugin-nx"
}
},
"root": "/packages/eslint-plugin-nx",
Expand Down Expand Up @@ -947,7 +947,7 @@
"isExternal": false,
"path": "/packages/express/documents/overview",
"tags": [],
"originalFilePath": "shared/express-plugin"
"originalFilePath": "shared/packages/express/express-plugin"
}
},
"root": "/packages/express",
Expand Down Expand Up @@ -990,7 +990,7 @@
"isExternal": false,
"path": "/packages/jest/documents/overview",
"tags": [],
"originalFilePath": "shared/jest-plugin"
"originalFilePath": "shared/packages/jest/jest-plugin"
}
},
"root": "/packages/jest",
Expand Down Expand Up @@ -1043,7 +1043,7 @@
"isExternal": false,
"path": "/packages/js/documents/overview",
"tags": [],
"originalFilePath": "shared/js-plugin"
"originalFilePath": "shared/packages/js/js-plugin"
}
},
"root": "/packages/js",
Expand Down Expand Up @@ -1123,7 +1123,7 @@
"isExternal": false,
"path": "/packages/linter/documents/overview",
"tags": [],
"originalFilePath": "shared/linter-plugin"
"originalFilePath": "shared/packages/linter/linter-plugin"
},
"/packages/linter/documents/eslint-plugin-nx": {
"id": "eslint-plugin-nx",
Expand All @@ -1134,7 +1134,7 @@
"isExternal": false,
"path": "/packages/linter/documents/eslint-plugin-nx",
"tags": [],
"originalFilePath": "shared/eslint-plugin-nx"
"originalFilePath": "shared/packages/linter/eslint-plugin-nx"
}
},
"root": "/packages/linter",
Expand Down Expand Up @@ -1199,7 +1199,7 @@
"isExternal": false,
"path": "/packages/nest/documents/overview",
"tags": [],
"originalFilePath": "shared/nest-plugin"
"originalFilePath": "shared/packages/nest/nest-plugin"
}
},
"root": "/packages/nest",
Expand Down Expand Up @@ -1395,7 +1395,7 @@
"isExternal": false,
"path": "/packages/next/documents/overview",
"tags": [],
"originalFilePath": "shared/next-plugin"
"originalFilePath": "shared/packages/next/next-plugin"
}
},
"root": "/packages/next",
Expand Down Expand Up @@ -1502,7 +1502,7 @@
"isExternal": false,
"path": "/packages/node/documents/overview",
"tags": [],
"originalFilePath": "shared/node-plugin"
"originalFilePath": "shared/packages/node/node-plugin"
}
},
"root": "/packages/node",
Expand Down Expand Up @@ -1878,7 +1878,7 @@
"isExternal": false,
"path": "/packages/nx-plugin/documents/overview",
"tags": [],
"originalFilePath": "shared/nx-plugin"
"originalFilePath": "shared/packages/nx-plugin/nx-plugin"
}
},
"root": "/packages/nx-plugin",
Expand Down Expand Up @@ -1967,7 +1967,7 @@
"isExternal": false,
"path": "/packages/react/documents/overview",
"tags": [],
"originalFilePath": "shared/react-plugin"
"originalFilePath": "shared/packages/react/react-plugin"
}
},
"root": "/packages/react",
Expand Down Expand Up @@ -2155,7 +2155,7 @@
"isExternal": false,
"path": "/packages/react-native/documents/overview",
"tags": [],
"originalFilePath": "shared/react-native-plugin"
"originalFilePath": "shared/packages/react-native/react-native-plugin"
}
},
"root": "/packages/react-native",
Expand Down Expand Up @@ -2366,7 +2366,7 @@
"isExternal": false,
"path": "/packages/storybook/documents/overview",
"tags": [],
"originalFilePath": "shared/guides/storybook/plugin-overview"
"originalFilePath": "shared/packages/storybook/plugin-overview"
},
"/packages/storybook/documents/overview-react": {
"id": "overview-react",
Expand All @@ -2377,7 +2377,7 @@
"isExternal": false,
"path": "/packages/storybook/documents/overview-react",
"tags": [],
"originalFilePath": "shared/guides/storybook/plugin-react"
"originalFilePath": "shared/packages/storybook/plugin-react"
},
"/packages/storybook/documents/overview-angular": {
"id": "overview-angular",
Expand All @@ -2388,7 +2388,7 @@
"isExternal": false,
"path": "/packages/storybook/documents/overview-angular",
"tags": [],
"originalFilePath": "shared/guides/storybook/plugin-angular"
"originalFilePath": "shared/packages/storybook/plugin-angular"
},
"/packages/storybook/documents/best-practices": {
"id": "best-practices",
Expand All @@ -2399,7 +2399,7 @@
"isExternal": false,
"path": "/packages/storybook/documents/best-practices",
"tags": [],
"originalFilePath": "shared/guides/storybook/best-practices"
"originalFilePath": "shared/packages/storybook/best-practices"
},
"/packages/storybook/documents/storybook-composition-setup": {
"id": "storybook-composition-setup",
Expand All @@ -2410,7 +2410,7 @@
"isExternal": false,
"path": "/packages/storybook/documents/storybook-composition-setup",
"tags": [],
"originalFilePath": "shared/guides/storybook/storybook-composition-setup"
"originalFilePath": "shared/packages/storybook/storybook-composition-setup"
},
"/packages/storybook/documents/angular-storybook-compodoc": {
"id": "angular-storybook-compodoc",
Expand All @@ -2421,7 +2421,7 @@
"isExternal": false,
"path": "/packages/storybook/documents/angular-storybook-compodoc",
"tags": [],
"originalFilePath": "shared/guides/storybook/angular-storybook-compodoc"
"originalFilePath": "shared/packages/storybook/angular-storybook-compodoc"
},
"/packages/storybook/documents/angular-storybook-targets": {
"id": "angular-storybook-targets",
Expand All @@ -2432,7 +2432,7 @@
"isExternal": false,
"path": "/packages/storybook/documents/angular-storybook-targets",
"tags": [],
"originalFilePath": "shared/guides/storybook/angular-storybook-targets"
"originalFilePath": "shared/packages/storybook/angular-storybook-targets"
},
"/packages/storybook/documents/angular-configuring-styles": {
"id": "angular-configuring-styles",
Expand All @@ -2443,7 +2443,7 @@
"isExternal": false,
"path": "/packages/storybook/documents/angular-configuring-styles",
"tags": [],
"originalFilePath": "shared/guides/storybook/angular-configuring-styles"
"originalFilePath": "shared/packages/storybook/angular-configuring-styles"
},
"/packages/storybook/documents/angular-browser-target": {
"id": "angular-browser-target",
Expand All @@ -2454,7 +2454,7 @@
"isExternal": false,
"path": "/packages/storybook/documents/angular-browser-target",
"tags": [],
"originalFilePath": "shared/guides/storybook/angular-browser-target"
"originalFilePath": "shared/packages/storybook/angular-browser-target"
},
"/packages/storybook/documents/migrate-webpack-final-angular": {
"id": "migrate-webpack-final-angular",
Expand All @@ -2465,7 +2465,7 @@
"isExternal": false,
"path": "/packages/storybook/documents/migrate-webpack-final-angular",
"tags": [],
"originalFilePath": "shared/guides/storybook/migrate-webpack-final-angular"
"originalFilePath": "shared/packages/storybook/migrate-webpack-final-angular"
},
"/packages/storybook/documents/upgrade-storybook-v6-angular": {
"id": "upgrade-storybook-v6-angular",
Expand All @@ -2476,7 +2476,7 @@
"isExternal": false,
"path": "/packages/storybook/documents/upgrade-storybook-v6-angular",
"tags": [],
"originalFilePath": "shared/guides/storybook/storybook-v6-angular"
"originalFilePath": "shared/packages/storybook/storybook-v6-angular"
},
"/packages/storybook/documents/migrate-webpack-final-react": {
"id": "migrate-webpack-final-react",
Expand All @@ -2487,7 +2487,7 @@
"isExternal": false,
"path": "/packages/storybook/documents/migrate-webpack-final-react",
"tags": [],
"originalFilePath": "shared/guides/storybook/migrate-webpack-final-react"
"originalFilePath": "shared/packages/storybook/migrate-webpack-final-react"
},
"/packages/storybook/documents/upgrade-storybook-v6-react": {
"id": "upgrade-storybook-v6-react",
Expand All @@ -2498,7 +2498,7 @@
"isExternal": false,
"path": "/packages/storybook/documents/upgrade-storybook-v6-react",
"tags": [],
"originalFilePath": "shared/guides/storybook/storybook-v6-react"
"originalFilePath": "shared/packages/storybook/storybook-v6-react"
}
},
"root": "/packages/storybook",
Expand Down Expand Up @@ -2590,7 +2590,7 @@
"isExternal": false,
"path": "/packages/vite/documents/overview",
"tags": [],
"originalFilePath": "shared/vite-plugin"
"originalFilePath": "shared/packages/vite/vite-plugin"
}
},
"root": "/packages/vite",
Expand Down Expand Up @@ -2670,7 +2670,7 @@
"isExternal": false,
"path": "/packages/web/documents/overview",
"tags": [],
"originalFilePath": "shared/web-plugin"
"originalFilePath": "shared/packages/web/web-plugin"
}
},
"root": "/packages/web",
Expand Down Expand Up @@ -2809,7 +2809,7 @@
"isExternal": false,
"path": "/packages/workspace/documents/overview",
"tags": [],
"originalFilePath": "shared/workspace-plugin"
"originalFilePath": "shared/packages/workspace/workspace-plugin"
},
"/packages/workspace/documents/nx-nodejs-typescript-version-matrix": {
"id": "nx-nodejs-typescript-version-matrix",
Expand All @@ -2820,7 +2820,7 @@
"isExternal": false,
"path": "/packages/workspace/documents/nx-nodejs-typescript-version-matrix",
"tags": [],
"originalFilePath": "shared/nx-compatibility-matrix"
"originalFilePath": "shared/packages/workspace/nx-compatibility-matrix"
}
},
"root": "/packages/workspace",
Expand Down
10 changes: 5 additions & 5 deletions docs/generated/packages/vite/documents/overview.md
View file
Expand Up @@ -168,7 +168,7 @@ If you are using React, you need to use the [`@vitejs/plugin-react` plugin](http
Add a `vite.config.ts` file to the root of your app. If you are not using React, you can skip adding the `react` plugin, of course.

```ts
// eg. apps/my-app/vite.config.ts
// e.g. apps/my-app/vite.config.ts
import { defineConfig } from 'vite';
import react from '@vitejs/plugin-react';
import ViteTsConfigPathsPlugin from 'vite-tsconfig-paths';
Expand All @@ -193,7 +193,7 @@ In that config file, you can configure Vite.js as you would normally do. For mor

You can create a `vite.config.ts` file to the root of your workspace, as well as at the root of each of your applications. This file is used to configure Vite. You can read more about the configuration options in the [Vite documentation](https://vitejs.dev/config/).

The root `vite.config.ts` file can be used for all applications, and you can place in there general configurations that would apply for all your apps using Vite in your workspace. The application-specific `vite.config.ts` files can be used to override the root configuration, or, for example, import framework-specific plugins (eg. the `'@vitejs/plugin-react'` for React apps). The application-specific configuration files extend (using [`mergeConfig`](https://vitejs.dev/guide/api-javascript.html#mergeconfig)) the root configuration file. You can adjust this behavior to your needs.
The root `vite.config.ts` file can be used for all applications, and you can place in here general configurations that would apply for all your apps using Vite in your workspace. The application-specific `vite.config.ts` files can be used to override the root configuration, or, for example, import framework-specific plugins (e.g. the `'@vitejs/plugin-react'` for React apps). The application-specific configuration files extend (using [`mergeConfig`](https://vitejs.dev/guide/api-javascript.html#mergeconfig)) the root configuration file. You can adjust this behavior to your needs.

So, if you are using a root `vite.config.ts` file, you should adjust your code as follows:

Expand All @@ -209,7 +209,7 @@ export default defineConfig({
and then in your app's `vite.config.ts` file:

```ts
// eg. apps/my-app/vite.config.ts
// e.g. apps/my-app/vite.config.ts
import { mergeConfig } from 'vite';
import baseConfig from '../../vite.config';
import react from '@vitejs/plugin-react';
Expand All @@ -227,7 +227,7 @@ export default mergeConfig(baseConfig, {

### 3. Move `index.html` and point it to your app's entrypoint

First of all, move your `index.html` file to the root of your app (eg. from `apps/my-app/src/index.html` to `apps/my-app/index.html`).
First of all, move your `index.html` file to the root of your app (e.g. from `apps/my-app/src/index.html` to `apps/my-app/index.html`).

Then, add a module `script` tag pointing to the `main.tsx` (or `main.ts`) file of your app:

Expand Down Expand Up @@ -268,7 +268,7 @@ You can use the `public` folder to store static **assets**, such as images, font

### 5. Adjust your app's tsconfig.json

Change your app's `tsconfig.json` (eg. `apps/my-app/tsconfig.json`) `compilerOptions` to the following:
Change your app's `tsconfig.json` (e.g. `apps/my-app/tsconfig.json`) `compilerOptions` to the following:

#### For React apps

Expand Down

1 comment on commit ae8e028

@vercel
Copy link

@vercel vercel bot commented on ae8e028 Dec 20, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

nx-dev – ./

nx-dev-nrwl.vercel.app
nx-five.vercel.app
nx.dev
nx-dev-git-master-nrwl.vercel.app

Please sign in to comment.