Skip to content

Commit

Permalink
docs: add note and warning
Browse files Browse the repository at this point in the history
  • Loading branch information
MunifTanjim committed Jun 16, 2023
1 parent 9a3086f commit d98e732
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,11 @@ use('MunifTanjim/prettier.nvim')

## Setup

> **Warning**
>
> Prettier won't be automatically installed by this plugin.
> You need to have it installed either globally or locally for the project.
### Setting up `null-ls`

For Latest Neovim:
Expand Down Expand Up @@ -90,6 +95,7 @@ null_ls.setup({
end,
})
```

</details>

### Setting Up `prettier.nvim`
Expand Down Expand Up @@ -119,6 +125,10 @@ prettier.setup({
})
```

> **Note**
>
> It's highly recommended that you use this plugin with [`prettierd`](https://github.com/fsouza/prettierd).
You can also supply some options to `null-ls`:

```lua
Expand Down Expand Up @@ -180,8 +190,9 @@ prettier.setup({
```

_**Note**:_
- _You can only use `prettier.nvim` with `vim.lsp.*` methods if prettier config file is present in your project directory._
- _Supported version of `prettierd` is `0.23.3+`._

- _You can only use `prettier.nvim` with `vim.lsp.*` methods if prettier config file is present in your project directory._
- _Supported version of `prettierd` is `0.23.3+`._

## Setup without LSP

Expand Down

0 comments on commit d98e732

Please sign in to comment.