Skip to content

Commit

Permalink
inserted temporary warnings for NvChad version 2.5
Browse files Browse the repository at this point in the history
  • Loading branch information
ambaradan committed Mar 11, 2024
1 parent 60332df commit 47fcf5e
Show file tree
Hide file tree
Showing 10 changed files with 46 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/books/nvchad/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 4 additions & 0 deletions docs/books/nvchad/install_nvchad.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 4 additions & 0 deletions docs/books/nvchad/marksman.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 4 additions & 0 deletions docs/books/nvchad/nvchad_ui/builtin_plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 4 additions & 0 deletions docs/books/nvchad/nvchad_ui/plugins_manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
4 changes: 4 additions & 0 deletions docs/books/nvchad/plugins/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 4 additions & 0 deletions docs/books/nvchad/plugins/md_preview.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 4 additions & 0 deletions docs/books/nvchad/plugins/projectmgr.md
Original file line number Diff line number Diff line change
Expand Up @@ -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*.
Expand Down
4 changes: 4 additions & 0 deletions docs/books/nvchad/template_chadrc.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 4 additions & 0 deletions docs/books/nvchad/vale_nvchad.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down

0 comments on commit 47fcf5e

Please sign in to comment.