From bbd664bbac20b3eb8b6cc29e9ee4521da127c149 Mon Sep 17 00:00:00 2001 From: Mika Vilpas Date: Tue, 28 May 2024 20:49:31 +0300 Subject: [PATCH] docs: use alerts to emphasize critical information --- README.md | 4 ++++ .../{ => for-developers}/lsp-renaming.md | 0 documentation/plugin-manager.md | 16 ++++++++++++---- 3 files changed, 16 insertions(+), 4 deletions(-) rename documentation/{ => for-developers}/lsp-renaming.md (100%) diff --git a/README.md b/README.md index d5dfdfc4..4521291a 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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. > diff --git a/documentation/lsp-renaming.md b/documentation/for-developers/lsp-renaming.md similarity index 100% rename from documentation/lsp-renaming.md rename to documentation/for-developers/lsp-renaming.md diff --git a/documentation/plugin-manager.md b/documentation/plugin-manager.md index a10741da..c8abe943 100644 --- a/documentation/plugin-manager.md +++ b/documentation/plugin-manager.md @@ -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 @@ -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: