readme wip

master
Brad Cornes 2020-06-22 21:11:54 +01:00
parent 170d6a7e44
commit 8edc015d6d
1 changed files with 28 additions and 4 deletions

View File

@ -2,7 +2,7 @@
## Installation ## Installation
**[Open in Visual Studio Code →](vscode:extension/bradlc.vscode-tailwindcss)** **[View in Visual Studio Code Marketplace →](https://marketplace.visualstudio.com/items?itemName=bradlc.vscode-tailwindcss)**
In order for the extension to activate you must have [`tailwindcss` installed](https://tailwindcss.com/docs/installation/#1-install-tailwind-via-npm) and a [Tailwind config file](https://tailwindcss.com/docs/installation/#3-create-your-tailwind-config-file-optional) named `tailwind.config.js` or `tailwind.js` in your workspace. In order for the extension to activate you must have [`tailwindcss` installed](https://tailwindcss.com/docs/installation/#1-install-tailwind-via-npm) and a [Tailwind config file](https://tailwindcss.com/docs/installation/#3-create-your-tailwind-config-file-optional) named `tailwind.config.js` or `tailwind.js` in your workspace.
@ -11,17 +11,17 @@ In order for the extension to activate you must have [`tailwindcss` installed](h
- **Autocomplete** - **Autocomplete**
Intelligent suggestions for class names, [CSS directives](https://tailwindcss.com/docs/functions-and-directives/), and the [`theme` helper](https://tailwindcss.com/docs/functions-and-directives/#theme) Intelligent suggestions for class names, [CSS directives](https://tailwindcss.com/docs/functions-and-directives/), and the [`theme` helper](https://tailwindcss.com/docs/functions-and-directives/#theme)
<img src="https://raw.githubusercontent.com/bradlc/vscode-tailwindcss/diagnostics/.github/autocomplete.png" alt="" /> <img src="https://raw.githubusercontent.com/bradlc/vscode-tailwindcss/diagnostics/.github/autocomplete.png" alt="" />
- **Hover Preview** - **Hover Preview**
See the complete CSS for a Tailwind class name by hovering over it See the complete CSS for a Tailwind class name by hovering over it
<img src="https://raw.githubusercontent.com/bradlc/vscode-tailwindcss/diagnostics/.github/hover.png" alt="" /> <img src="https://raw.githubusercontent.com/bradlc/vscode-tailwindcss/diagnostics/.github/hover.png" alt="" />
- **Linting** - **Linting**
Highlights errors and potential bugs in your HTML and CSS files Highlights errors and potential bugs in your HTML and CSS files
<img src="https://raw.githubusercontent.com/bradlc/vscode-tailwindcss/diagnostics/.github/linting.png" alt="" /> <img src="https://raw.githubusercontent.com/bradlc/vscode-tailwindcss/diagnostics/.github/linting.png" alt="" />
- **CSS Syntax Highlighting** - **CSS Syntax Highlighting**
Provides syntax definitions so that use of Tailwind features doesnt mess up your syntax highlighting Provides syntax definitions so that use of Tailwind features doesnt mess up your syntax highlighting
@ -59,3 +59,27 @@ Enable linting. Rules can be configured individually using the `tailwindcss.lint
- `ignore`: disable lint rule entirely - `ignore`: disable lint rule entirely
- `warning`: rule violations will be considered "warnings," typically represented by a yellow underline - `warning`: rule violations will be considered "warnings," typically represented by a yellow underline
- `error`: rule violations will be considered "errors," typically represented by a red underline - `error`: rule violations will be considered "errors," typically represented by a red underline
### `tailwindCSS.lint.invalidScreen`
Unknown screen name used with the [`@screen` directive](https://tailwindcss.com/docs/functions-and-directives/#screen). **Default: `error`**
### `tailwindCSS.lint.invalidVariant`
Unknown variant name used with the [`@variants` directive](https://tailwindcss.com/docs/functions-and-directives/#variants). **Default: `error`**
### `tailwindCSS.lint.invalidTailwindDirective`
Unknown value used with the [`@tailwind` directive](https://tailwindcss.com/docs/functions-and-directives/#tailwind). **Default: `error`**
### `tailwindCSS.lint.invalidApply`
Unsupported use of the [`@apply` directive](https://tailwindcss.com/docs/functions-and-directives/#apply). For example class names which contain pseudo selectors cannot currently be used with `@apply`. **Default: `error`**
### `tailwindCSS.lint.invalidConfigPath`
Unknown or invalid path used with the [`theme` helper](https://tailwindcss.com/docs/functions-and-directives/#theme). **Default: `error`**
### `tailwindCSS.lint.cssPropertyConflict`
Class names on the same HTML element which apply the same CSS property or properties. **Default: `warning`**