Skip to content

Commit

Permalink
docs: auto generate
Browse files Browse the repository at this point in the history
  • Loading branch information
luckasRanarison authored and github-actions[bot] committed Aug 16, 2024
1 parent f906762 commit 2ab47b0
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions doc/tailwind-tools.nvim.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
*tailwind-tools.nvim.txt* For NVIM v0.9.0 Last change: 2024 August 14
*tailwind-tools.nvim.txt* For NVIM v0.9.0 Last change: 2024 August 16

[!IMPORTANT] This plugin is a community project and is **NOT** officially
supported by Tailwind Labs <https://github.com/tailwindlabs>.
Expand Down Expand Up @@ -50,15 +50,11 @@ It currently provides the following features:
PREREQUISITES *tailwind-tools.nvim-prerequisites*

- Neovim v0.9 or higher (v0.10 is recommended)
- tailwindcss-language-server <https://github.com/tailwindlabs/tailwindcss-intellisense/tree/master/packages/tailwindcss-language-server> >= `v0.0.14` (can be installed using Mason <https://github.com/williamboman/mason.nvim>)
- tailwindcss-language-server <https://github.com/tailwindlabs/tailwindcss-intellisense/tree/master/packages/tailwindcss-language-server> >= `v0.0.14` (can be installed using Mason <https://github.com/williamboman/mason.nvim> or npm)
- `html`, `css`, `tsx` and other language Treesitter grammars (using nvim-treesitter <https://github.com/nvim-treesitter/nvim-treesitter>)
- Neovim node-client <https://www.npmjs.com/package/neovim> (using npm)


[!TIP] If you are not familiar with neovim LSP ecosystem check out
nvim-lspconfig <https://github.com/neovim/nvim-lspconfig> to learn how to setup
the LSP.

INSTALLATION *tailwind-tools.nvim-installation*

Using lazy.nvim <https://github.com/folke/lazy.nvim>:
Expand All @@ -72,6 +68,7 @@ Using lazy.nvim <https://github.com/folke/lazy.nvim>:
dependencies = {
"nvim-treesitter/nvim-treesitter",
"nvim-telescope/telescope.nvim", -- optional
"neovim/nvim-lspconfig", -- optional
},
opts = {} -- your configuration
}
Expand All @@ -92,11 +89,20 @@ CONFIGURATION *tailwind-tools.nvim-configuration*


[!IMPORTANT] Neovim v0.10 is required for vscode-like inline color hints.
By default, the plugin automatically configures the server using nvim-lspconfig
<https://github.com/neovim/nvim-lspconfig>, if it is installed. Make sure you
do not set up the server elsewhere.

Here is the default configuration:

>lua
---@type TailwindTools.Option
{
server = {
override = true, -- setup the server from the plugin if true
settings = {} -- shortcut for `settings.tailwindCSS`,
on_attach = function(client, bufnr) end, -- callback triggered when the server attaches to a buffer
},
document_color = {
enabled = true, -- can be toggled by commands
kind = "inline", -- "inline" | "foreground" | "background"
Expand Down

0 comments on commit 2ab47b0

Please sign in to comment.