Skip to content

Commit

Permalink
Improve language across multiple documentation files (#710)
Browse files Browse the repository at this point in the history
* Enhanced clarity and readability of the content across 11 documentation files.
* Corrected various grammar, syntax, and punctuation errors.
* Improved phrasing and use of terminology where required.
* Ensured consistency in language and style across the documents.
* Optimized sentence structure for better understanding.
  • Loading branch information
nicokempe committed Aug 6, 2023
1 parent 43234be commit 92b7be2
Show file tree
Hide file tree
Showing 11 changed files with 24 additions and 24 deletions.
4 changes: 2 additions & 2 deletions docs/content/0.index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Welcome to [@nuxtjs/tailwindcss](https://github.com/nuxt-modules/tailwindcss) mo
Zero Configuration

#description
This module helps you set up Tailwind CSS in your Nuxt application in seconds.
This module enables a quick and easy setup of Tailwind CSS in your Nuxt application.
::
::card{icon=🪆}
#title
Expand Down Expand Up @@ -64,6 +64,6 @@ Welcome to [@nuxtjs/tailwindcss](https://github.com/nuxt-modules/tailwindcss) mo
Open Source

#description
Counting 75+ contributors and 400k+ monthly downloads.
Boasting over 75+ contributors and over 400k+ monthly downloads.
::
::
4 changes: 2 additions & 2 deletions docs/content/1.getting-started/1.setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,13 +53,13 @@ When running `npm run dev`, this module will look for these files:
- `./assets/css/tailwind.css`
- `./tailwind.config.{js,cjs,mjs,ts}`

If they don't exist, the module will inject a basic configuration for each one so you don't have to create these files.
If these files don't exist, the module will automatically generate a basic configuration for them, so you don't have to create these files manually.

::alert{type="info"}
You can configure the paths in the [module options](/getting-started/options).
::

If you're going to create your own Tailwind CSS file, make sure to add the `@tailwind` directives for each of Tailwind’s layers.
If you're going to create your own Tailwind CSS file, make sure to add the `@tailwind` directives for each of Tailwind’s layer types (base, components, and utilities).

```css
@tailwind base;
Expand Down
8 changes: 4 additions & 4 deletions docs/content/1.getting-started/2.options.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ export default {

This file will be directly injected as a [global CSS](https://nuxt.com/docs/api/configuration/nuxt-config#css) for Nuxt. It supports `css`, `sass`, `postcss`, and more.

If you don't want to inject CSS file, you can set `cssPath` to `false`.
If you don't want to inject the CSS file, you can set `cssPath` to `false`.

```ts [nuxt.config]
export default {
Expand Down Expand Up @@ -104,7 +104,7 @@ export default {
}
```

This is only relevant when [`exposeConfig`](/getting-started/options#exposeconfig) is `true`. Using `exposeLevel` to be ≤ 0 will only expose root properties.
This is only relevant when [`exposeConfig`](/getting-started/options#exposeconfig) is set to `true`. Setting `exposeLevel` to ≤ 0 will only expose root properties.

::alert{type="warning"}

Expand All @@ -125,8 +125,8 @@ Named exports for properties below [root options](https://tailwindcss.com/docs/c
This option lets you adjust the position of the [global CSS](https://nuxt.com/docs/api/configuration/nuxt-config#css) injection, which affects the CSS priority. You can use multiple formats to define the position:

* Use `'first'` and `'last'` literals to make Tailwind CSS first or last respectively. First position has the lowest priority, last position overrides everything and hence has the highest priority.
* Use `{ after: 'some/existing/file.css' } ` to specify the position explicitly.
* You can use any integer to specify absolute position in the array. This is the most fragile way, as it's easy to forget to adjust it when changing CSS settings.
* Use `{ after: 'some/existing/file.css' } ` to explicitly specify the position.
* You can use any integer to specify absolute position in the array. This approach is less stable, as it can be easy to forget to adjust it when changing CSS settings.

```ts [nuxt.config]
export default {
Expand Down
6 changes: 3 additions & 3 deletions docs/content/2.tailwind/1.config.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ Learn more about the [Tailwind config](https://tailwindcss.com/docs/configuratio

### `config` option

You can also use your `nuxt.config` to set your Tailwind config with the `tailwindcss.config` property:
You can also use your `nuxt.config` file to set your Tailwind config with the `tailwindcss.config` property:

```js [nuxt.config]
import tailwindTypography from '@tailwindcss/typography'
Expand Down Expand Up @@ -244,7 +244,7 @@ This merging strategy of with a function only applies to `plugins` and `content`

### Safelisting classes

If you need to safelist classes and avoid the content purge system, you need to specify the `safelist` option:
If you need to safelist classes and avoid the content purging system, you need to specify the `safelist` option:

```js{}[tailwind.config.js]
module.exports = {
Expand Down Expand Up @@ -273,7 +273,7 @@ export default {
}
```

Then import where needed from `#tailwind-config`:
Then, import where needed from `#tailwind-config`:

```js
// Import fully resolved config
Expand Down
6 changes: 3 additions & 3 deletions docs/content/2.tailwind/2.viewer.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ Visualize your Tailwind configuration with the viewer.

---

Nuxt Tailwind will expose a `/_tailwind/` route in development, so that you can quickly visualize your Tailwind configuration with easy copy-pasting (thanks to the awesome [tailwind-config-viewer](https://github.com/rogden/tailwind-config-viewer) package ✨).
Nuxt Tailwind exposes a `/_tailwind/` route in development, allowing you to quickly visualize your Tailwind configuration with easy copy-pasting (thanks to the awesome [tailwind-config-viewer](https://github.com/rogden/tailwind-config-viewer) package ✨).

The viewer is available from the `v3.4.0` of `@nuxtjs/tailwindcss`.
The viewer is available starting from version `v3.4.0` of `@nuxtjs/tailwindcss`.

<video poster="https://res.cloudinary.com/nuxt/video/upload/v1608225750/nuxt-tailwind-viewer_ktowjm.jpg" loop playsinline controls>
<source src="https://res.cloudinary.com/nuxt/video/upload/q_auto/v1608225750/nuxt-tailwind-viewer_ktowjm.webm" type="video/webm" />
Expand All @@ -18,4 +18,4 @@ When enabled, you will see the Tailwind viewer url in your terminal:

<img src="/tailwind-viewer.png" width="530" height="246" style="margin: 0;" />

Checkout the [viewer option](/getting-started/options#viewer) to disable the viewer in development.
Check out the [viewer option](/getting-started/options#viewer) to disable the viewer in development.
6 changes: 3 additions & 3 deletions docs/content/2.tailwind/3.editor-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Improve your development experience with features such as autocomplete, syntax h

---

Tailwind provides an [extension for Visual Studio Code](https://github.com/tailwindlabs/tailwindcss-intellisense), which enables advanced features such as autocomplete, syntax highlighting, and linting.
Tailwind provides an [extension for Visual Studio Code](https://github.com/tailwindlabs/tailwindcss-intellisense), that provides advanced features such as autocomplete, syntax highlighting, and linting.

You can [install it via the Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=bradlc.vscode-tailwindcss).

Expand All @@ -19,7 +19,7 @@ Add the following configuration to your `.vscode/settings.json` file, so that Ta
}
```

If you use pnpm, make sure that tailwindcss is installed in your top level node_modules folder.
If you use pnpm, ensure that tailwindcss is installed in your top-level node_modules folder.

Since Tailwind CSS v3.3, [ESM/TS configuration has been supported](https://tailwindcss.com/blog/tailwindcss-v3-3#esm-and-type-script-support) so your editor should automatically configure autocomplete based on your `tailwind.config`. If you happen to use a lower version and/or require the configuration in CommonJS, you can use the `tailwindcss:resolvedConfig` hook and a custom Nuxt module:

Expand Down Expand Up @@ -48,4 +48,4 @@ export default defineNuxtModule({
// ...
```

This hook will allow you to customise your generated template through a module in different ways (e.g., different filename, contents, etc.). Please note that `JSON.stringify` will remove plugins from your configuration.
This hook allows you to customize your generated template in different ways (e.g., different filename, contents, etc.) through a module. Please be aware that using `JSON.stringify` will remove plugins from your configuration.
2 changes: 1 addition & 1 deletion docs/content/3.examples/1.basic.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ Live example of basic usage of Nuxt and Tailwind CSS.

---

Minimal example of a Nuxt project with Tailwind CSS module.
Here is a minimal example of a Nuxt project using the Tailwind CSS module.

:sandbox{src="https://stackblitz.com/edit/nuxt-tailwindcss-starter?embed=1&file=pages%2Findex.vue"}
6 changes: 3 additions & 3 deletions docs/content/3.examples/2.dark-mode.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ Live example of dark mode with Nuxt Tailwind.

---

Example with the [Tailwind Dark Mode](https://tailwindcss.com/docs/dark-mode) and [@nuxtjs/color-mode](https://github.com/nuxt-modules/color-mode) module.
This is an example using the [Tailwind Dark Mode](https://tailwindcss.com/docs/dark-mode) and [@nuxtjs/color-mode](https://github.com/nuxt-modules/color-mode) module.

To make it work hand-in-hand, you need to update your `tailwind.config` to add
To make it work hand-in-hand, you need to update your `tailwind.config` by adding the following:

```ts [tailwind.config.ts]
import type { Config } from 'tailwindcss'
Expand All @@ -20,7 +20,7 @@ export default <Partial<Config>>{
}
```

And add the `classSuffix` to the colorMode module options:
And, add the `classSuffix` to the colorMode module options:

```ts [nuxt.config.ts]
export default defineNuxtConfig({
Expand Down
2 changes: 1 addition & 1 deletion docs/content/3.examples/3.nuxtlabs-ui.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ toc: false

# NuxtLabs UI

Live example of [NuxtLabs UI](https://ui.nuxtlabs.com) module.
Live example of the [NuxtLabs UI](https://ui.nuxtlabs.com) module.

:sandbox{src="https://stackblitz.com/edit/nuxt-nuxtlabs-ui?file=pages%2Findex.vue"}
2 changes: 1 addition & 1 deletion docs/content/3.examples/4.postcss-plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ toc: false

# PostCSS Plugins

Live example of Nuxt Tailwind with postcss-color-gray plugin.
Live example of Nuxt Tailwind using the postcss-color-gray plugin.

---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/3.examples/7.tailwind-icons.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Tailwind Icons

Example of using [tailwindcss-icons](https://github.com/egoist/tailwindcss-icons) plugin.
Example of using the [tailwindcss-icons](https://github.com/egoist/tailwindcss-icons) plugin.


:sandbox{src="https://stackblitz.com/edit/nuxt-tailwindcss-icons?embed=1&file=app.vue" class="h-[600px]"}

0 comments on commit 92b7be2

Please sign in to comment.