From 8edc015d6dcd3574537aaf8b7ea7daa9615077cf Mon Sep 17 00:00:00 2001 From: Brad Cornes Date: Mon, 22 Jun 2020 21:11:54 +0100 Subject: [PATCH] readme wip --- README.md | 32 ++++++++++++++++++++++++++++---- 1 file changed, 28 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index b8bbded..9390872 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ## 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. @@ -11,17 +11,17 @@ In order for the extension to activate you must have [`tailwindcss` installed](h - **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) - + - **Hover Preview** See the complete CSS for a Tailwind class name by hovering over it - + - **Linting** Highlights errors and potential bugs in your HTML and CSS files - + - **CSS Syntax Highlighting** Provides syntax definitions so that use of Tailwind features doesn’t 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 - `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 + +### `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`**