Skip to content

Commit

Permalink
docs: use alerts to emphasize critical information
Browse files Browse the repository at this point in the history
  • Loading branch information
mikavilpas committed May 28, 2024
1 parent e9209f7 commit bbd664b
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 4 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ First, make sure you have the requirements:
- Neovim 0.10.x or later
- yazi [0.2.5](https://github.com/sxyazi/yazi/releases/tag/v0.2.5) or later

> [!TIP]
>
> You can run `:checkhealth yazi` to see if compatible versions are installed
> and working.
Expand Down Expand Up @@ -74,6 +76,8 @@ Using [lazy.nvim](https://github.com/folke/lazy.nvim):

### ⚙️⚙️ Advanced configuration

> [!IMPORTANT]
>
> You don't have to set any of these options. The defaults are fine for most
> users.
>
Expand Down
File renamed without changes.
16 changes: 12 additions & 4 deletions documentation/plugin-manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,13 +78,19 @@ The benefits of using the yazi.nvim plugin manager are:

## Caveats

> [!NOTE]
>
> Note that only [lazy.nvim](https://github.com/folke/lazy.nvim) is supported at
> the moment.
> Note that Yazi also ships with its own plugin manager. Some of the features
> are very similar. The intent is to provide a more integrated experience with
> the same (or, if possible, improved) features.
> [!NOTE]
>
> Yazi also ships with its own plugin manager. Some of the features are very
> similar. The intent is to provide a more integrated experience with the same
> (or, if possible, improved) features.
> [!NOTE]
>
> Right now, it's not known if it works on Windows. Please report any issues.
As the Yazi plugin system is currently in beta, the yazi.nvim plugin manager is
Expand All @@ -93,7 +99,9 @@ plugin manager.

## More technical details and examples

> Note: this section is for advanced users.
> [!NOTE]
>
> This section is for advanced users.
```lua
-- Example plugins:
Expand Down

0 comments on commit bbd664b

Please sign in to comment.