Zengtudor/Nuxt
1
0
Fork 0
mirror of https://github.com/nuxt/nuxt.git synced 2024-11-25 15:15:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix typos and capitalisation (#9844)

Browse Source 
* docs(getting-started): fix typos in configuration docs

* docs(community): always capitalize 'Prettier'

* docs(community): always capitalize 'Corepack'

* docs(community): always capitalize 'Nuxt'
This commit is contained in:
Hugo Brosnahan 2023-01-03 05:17:25 +11:00 committed by GitHub
parent da2a146f50
commit 850733e160
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/content/1.docs/1.getting-started/3.configuration.md
View File

@ -69,7 +69,7 @@ const runtimeConfig = useRuntimeConfig()
## App Configuration ## App Configuration
The `app.config.ts` file, also located at the root of a Nuxt project, is used to expose public variables that can be determined at build time. Contrary to the `runtimeConfig` option, these can not be overriden using environment variables. The `app.config.ts` file, also located at the root of a Nuxt project, is used to expose public variables that can be determined at build time. Contrary to the `runtimeConfig` option, these can not be overridden using environment variables.
A minimal configuration file exports the `defineAppConfig` function containing an object with your configuration. The `defineAppConfig` helper is globally available without import. A minimal configuration file exports the `defineAppConfig` function containing an object with your configuration. The `defineAppConfig` helper is globally available without import.
@ -129,7 +129,7 @@ Here is a list of other common config files:
Name | Config File | How To Configure Name | Config File | How To Configure
|---------------------------------------------|-------------------------|-------------------------- |---------------------------------------------|-------------------------|--------------------------
| [Typescipt](https://www.typescriptlang.org) | `tsconfig.json` | [More Info](/docs/guide/concepts/typescript#nuxttsconfigjson) | [TypeScript](https://www.typescriptlang.org) | `tsconfig.json` | [More Info](/docs/guide/concepts/typescript#nuxttsconfigjson)
| [ESLint](https://eslint.org) | `.eslintrc.js` | [More Info](https://eslint.org/docs/latest/user-guide/configuring/configuration-files) | [ESLint](https://eslint.org) | `.eslintrc.js` | [More Info](https://eslint.org/docs/latest/user-guide/configuring/configuration-files)
| [Prettier](https://prettier.io) | `.prettierrc.json` | [More Info](https://prettier.io/docs/en/configuration.html) | [Prettier](https://prettier.io) | `.prettierrc.json` | [More Info](https://prettier.io/docs/en/configuration.html)
| [Stylelint](https://stylelint.io) | `.stylelintrc.json` | [More Info](https://stylelint.io/user-guide/configure) | [Stylelint](https://stylelint.io) | `.stylelintrc.json` | [More Info](https://stylelint.io/user-guide/configure)

2
docs/content/1.docs/5.community/3.reporting-bugs.md
View File

@ -49,4 +49,4 @@ Once you've reproduced the issue, remove as much code from your reproduction as
## Figure Out What the Cause Might Be ## Figure Out What the Cause Might Be
With a Nuxt project, there are lots of moving pieces - from [nuxt modules](https://nuxtjs.org/modules) to [other JavaScript libraries](https://www.npmjs.com/). Try to report the bug at the most relevant and specific place. That will likely be the Nuxt module causing an issue, or the upstream library that Nuxt is depending on. With a Nuxt project, there are lots of moving pieces - from [Nuxt modules](https://nuxtjs.org/modules) to [other JavaScript libraries](https://www.npmjs.com/). Try to report the bug at the most relevant and specific place. That will likely be the Nuxt module causing an issue, or the upstream library that Nuxt is depending on.

6
docs/content/1.docs/5.community/4.contribution.md
View File

@ -130,7 +130,7 @@ Most of the Nuxt ecosystem can consume ESM directly. In general we advocate that
[Corepack](https://nodejs.org/api/corepack.html) makes sure you are using the correct version for package manager when you run corresponding commands. Projects might have `packageManager` field in their `package.json`. [Corepack](https://nodejs.org/api/corepack.html) makes sure you are using the correct version for package manager when you run corresponding commands. Projects might have `packageManager` field in their `package.json`.
Under projects with configuration as shown below, corepack will install `v7.5.0` of `pnpm` (if you don't have it already) and use it to run your commands. Under projects with configuration as shown below, Corepack will install `v7.5.0` of `pnpm` (if you don't have it already) and use it to run your commands.
```jsonc [package.json] ```jsonc [package.json]
{ {
@ -161,13 +161,13 @@ Since ESLint is already configured to format the code, there is no need to dupli
If you have Prettier installed in your editor, we recommend you disable it when working on the project to avoid conflict. If you have Prettier installed in your editor, we recommend you disable it when working on the project to avoid conflict.
**Note**: [we are discussing](https://github.com/nuxt/eslint-config/issues/224) enabling prettier in future. **Note**: [we are discussing](https://github.com/nuxt/eslint-config/issues/224) enabling Prettier in future.
#### Package Manager #### Package Manager
For libraries, we recommend `pnpm`. For modules, we still recommend `yarn` but we may well switch this recommendation to `pnpm` in future once we support plug and play mode with Nuxt itself. For libraries, we recommend `pnpm`. For modules, we still recommend `yarn` but we may well switch this recommendation to `pnpm` in future once we support plug and play mode with Nuxt itself.
It is important to enable corepack to ensure you are on the same version of the package manager as the project. Corepack is built-in to new node versions for seamless package manager integration. It is important to enable Corepack to ensure you are on the same version of the package manager as the project. Corepack is built-in to new node versions for seamless package manager integration.
To enable it, run To enable it, run