From 47fcf5e1388c46e2e353610d2e35e11e6777e754 Mon Sep 17 00:00:00 2001 From: ambaradan Date: Mon, 11 Mar 2024 12:21:23 +0100 Subject: [PATCH] inserted temporary warnings for NvChad version 2.5 --- docs/books/nvchad/index.md | 10 ++++++++++ docs/books/nvchad/install_nvchad.md | 4 ++++ docs/books/nvchad/marksman.md | 4 ++++ docs/books/nvchad/nvchad_ui/builtin_plugins.md | 4 ++++ docs/books/nvchad/nvchad_ui/plugins_manager.md | 4 ++++ docs/books/nvchad/plugins/index.md | 4 ++++ docs/books/nvchad/plugins/md_preview.md | 4 ++++ docs/books/nvchad/plugins/projectmgr.md | 4 ++++ docs/books/nvchad/template_chadrc.md | 4 ++++ docs/books/nvchad/vale_nvchad.md | 4 ++++ 10 files changed, 46 insertions(+) diff --git a/docs/books/nvchad/index.md b/docs/books/nvchad/index.md index c6a131be03..0361b449dc 100644 --- a/docs/books/nvchad/index.md +++ b/docs/books/nvchad/index.md @@ -11,6 +11,16 @@ tags: # :material-book-open-page-variant-outline: Introduction +!!! warning "Release 2.5 changes" + + With the release of version 2.5, the developers of the editor significantly changed the structure of the configuration. The most important changes concern the following aspects: + + * The transformation of the configuration into a Neovim plugin, which can then be updated using the *lazy.nvim* plugins manager + * The removal of the `custom` folder for editor customization (now integrated into the main folder). A [migration script](https://gist.github.com/siduck/048bed2e7570569e6b327b35d1715404) is provided for current users. + * The mappings have been changed and no longer use nvchad's custom syntax, instead nvim's **vim.keymap.set** is used. + + As a result, some pages of the guide, especially the whole part concerning the installation of NvChad and the subsequent installation of plugins appears to be incorrect. The guide is **under revision** and will be updated as soon as possible. + Throughout this book, you will find ways to implement Neovim, along with NvChad, to create a fully functional ==**I**ntegrated **D**evelopment **E**nvironment== (IDE). I say "ways" because there are many possibilities. The author focuses here on using these tools for writing markdown, but if markdown isn't your focus, don't worry simply read on. If you are unfamiliar with either of these tools (NvChad or Neovim), then this book will give you an introduction to both, and if you step through these documents, you'll soon realize that you can set up this environment to be a huge help for whatever your programming or script writing needs are. diff --git a/docs/books/nvchad/install_nvchad.md b/docs/books/nvchad/install_nvchad.md index 8cc40d4429..0c461d00c4 100644 --- a/docs/books/nvchad/install_nvchad.md +++ b/docs/books/nvchad/install_nvchad.md @@ -11,6 +11,10 @@ tags: # :simple-neovim: Turning Neovim into an advanced IDE +!!! danger "Wrong instructions" + + With the release of version 2.5, the instructions on this page are no longer correct; its use is not recommended for new installations. For more information see [the main page of the guide](./index.md). + ## :material-arrow-bottom-right-bold-outline: Pre-requisites As specified on the NvChad site you need to ensure the system meets the following requirements: diff --git a/docs/books/nvchad/marksman.md b/docs/books/nvchad/marksman.md index 075b40db8e..2bc928cfe9 100644 --- a/docs/books/nvchad/marksman.md +++ b/docs/books/nvchad/marksman.md @@ -11,6 +11,10 @@ tags: # Marksman - code assistant +!!! danger "Wrong instructions" + + With the release of version 2.5, the instructions on this page are no longer correct; its use is not recommended for new installations. For more information see [the main page of the guide](./index.md). + Marksman is a useful tool when drafting your document for Rocky Linux. It allows the easy entry of symbols needed to define the *markdown* language tags. This allows you to write faster and reduces the possibility of errors. NvChad/Neovim already includes text widgets that aid writing, such as the repetition of often-used words indexed by frequency of entry. The new options included by this language server will enrich these widgets. diff --git a/docs/books/nvchad/nvchad_ui/builtin_plugins.md b/docs/books/nvchad/nvchad_ui/builtin_plugins.md index e2d934a548..a58ac82aef 100644 --- a/docs/books/nvchad/nvchad_ui/builtin_plugins.md +++ b/docs/books/nvchad/nvchad_ui/builtin_plugins.md @@ -11,6 +11,10 @@ tags: # Basic configuration plugins +!!! danger "Wrong instructions" + + With the release of version 2.5, the instructions on this page are no longer correct; its use is not recommended for new installations. For more information see [the main page of the guide](../index.md). + !!! note "Plugin Naming Convention" In this chapter, the format `user_github/plugin_name` will be used to identify the plugin. This is to avoid possible errors with similarly named plugins and to introduce the format that is used for plugin entry by both NvChad, and the `custom` configuration. diff --git a/docs/books/nvchad/nvchad_ui/plugins_manager.md b/docs/books/nvchad/nvchad_ui/plugins_manager.md index 067dc025a9..874c952abd 100644 --- a/docs/books/nvchad/nvchad_ui/plugins_manager.md +++ b/docs/books/nvchad/nvchad_ui/plugins_manager.md @@ -11,6 +11,10 @@ tags: # Plugins Manager +!!! danger "Wrong instructions" + + With the release of version 2.5, the instructions on this page are no longer correct; its use is not recommended for new installations. For more information see [the main page of the guide](../index.md). + The management of plugins in NvChad 2.0 is done by [folke/lazy.nvim](https://github.com/folke/lazy.nvim), this plugin is installed during the first installation from the bootstrap procedure. The plugin allows you to perform all common operations on plugins, such as installing, updating, etc. ![Lazy Nvim](../images/lazy_nvim.png) diff --git a/docs/books/nvchad/plugins/index.md b/docs/books/nvchad/plugins/index.md index a5b1d2434a..4e04828805 100644 --- a/docs/books/nvchad/plugins/index.md +++ b/docs/books/nvchad/plugins/index.md @@ -11,6 +11,10 @@ tags: # Overview +!!! danger "Wrong instructions" + + With the release of version 2.5, the instructions on this page are no longer correct; its use is not recommended for new installations. For more information see [the main page of the guide](../index.md). + ## Introduction The custom configuration created by the developers of NvChad allows you to have an integrated environment with many of the features of a graphical IDE. These features are built into the Neovim configuration by means of plugins. Those selected for NvChad by the developers have the function of setting up the editor for general use. diff --git a/docs/books/nvchad/plugins/md_preview.md b/docs/books/nvchad/plugins/md_preview.md index 7c7251dcbe..581e15fcb9 100644 --- a/docs/books/nvchad/plugins/md_preview.md +++ b/docs/books/nvchad/plugins/md_preview.md @@ -11,6 +11,10 @@ tags: # Markdown Preview +!!! danger "Wrong instructions" + + With the release of version 2.5, the instructions on this page are no longer correct; its use is not recommended for new installations. For more information see [the main page of the guide](../index.md). + ## Introduction One of the features of the Markdown language that make it widely used in writing technical documentation is its convertibility. Code can be converted for display in many formats (HTML, PDF, plain text,..), therefore making content usable in numerous scenarios. diff --git a/docs/books/nvchad/plugins/projectmgr.md b/docs/books/nvchad/plugins/projectmgr.md index 9533650605..d64188f676 100644 --- a/docs/books/nvchad/plugins/projectmgr.md +++ b/docs/books/nvchad/plugins/projectmgr.md @@ -13,6 +13,10 @@ tags: ## Introduction +!!! danger "Wrong instructions" + + With the release of version 2.5, the instructions on this page are no longer correct; its use is not recommended for new installations. For more information see [the main page of the guide](../index.md). + One of the features that an IDE must surely have is the ability to manage the various projects that a developer or publisher works on. Being able to select the project to work on once NvChad is open, without the need to type commands in the *statusline* to achieve the goal. This saves time and allows for simplified management in the case of a large number of projects. Using [charludo/projectmgr.nvim](https://github.com/charludo/projectmgr.nvim) will integrate this functionality. The plugin provides excellent integration with `Telescope` and some interesting additional features such as the ability to synchronize a *git* repository when opening the *project*. diff --git a/docs/books/nvchad/template_chadrc.md b/docs/books/nvchad/template_chadrc.md index 79c04e51c1..36ef545fc7 100644 --- a/docs/books/nvchad/template_chadrc.md +++ b/docs/books/nvchad/template_chadrc.md @@ -11,6 +11,10 @@ tags: # Example configuration +!!! danger "No longer provided" + + The example configuration is no longer provided during the installation of NvChad, consequently this page is obsolete and will be removed in the new version of the guide. The instructions will be updated as soon as possible. + ## :material-message-outline: Introduction Version 2.0 of NvChad introduces the ability to create a ==custom== folder during the installation phase. Its creation is the starting point for customizing the editor by modifying its files. Installed at bootstrap it allows for an editor with the basic features of an IDE at first startup but can also be included after the installation of NvChad. diff --git a/docs/books/nvchad/vale_nvchad.md b/docs/books/nvchad/vale_nvchad.md index 7f08fb631c..960d6a2ed3 100644 --- a/docs/books/nvchad/vale_nvchad.md +++ b/docs/books/nvchad/vale_nvchad.md @@ -9,6 +9,10 @@ tags: # `vale` in NvChad (Neovim) +!!! danger "Wrong instructions" + + With the release of version 2.5, the instructions on this page are no longer correct; its use is not recommended for new installations. For more information see [the main page of the guide](../index.md). + ## :material-message-outline: Introduction `vale.sh` is one of the foremost open source projects for technical writers looking to improve their voice and style consistency. It can be used with a number of editors on nearly every major OS platform (Linux, MacOS, Windows). You can find out more about the project by heading up to [the vale.sh website](https://vale.sh/). This guide is going to walk you through adding `vale` to NvChad. Since it is included in the Mason packages used for install, the process is not too difficult, although it does involve some minor editing and configuration to get things going. To be clear, NvChad is really the configuration manager for the editor Neovim, so from this point forward, the reference will be `nvim`.