kickstart.nvim/README.md

kickstart.nvim/

Install Instructions

Install requires Neovim 0.9+. Always review the code before installing a configuration.

Installation

Install Neovim

Kickstart.nvim targets only the latest 'stable' and latest 'nightly' of Neovim. If you are experiencing issues, please make sure you have the latest versions.

Install External Dependencies

External Requirements:

• Basic utils: git, make, unzip, C Compiler (gcc)
• ripgrep, fd-find
• Clipboard tool (xclip/xsel/win32yank or other depending on the platform)
• A Nerd Font: optional, provides various icons
  • if you have it set vim.g.have_nerd_font in init.lua to true
• Emoji fonts (Ubuntu only, and only if you want emoji!) sudo apt install fonts-noto-color-emoji
• Language Setup:
  • If you want to write Typescript, you need npm
  • If you want to write Golang, you will need go
  • etc.

[!NOTE] See Install Recipes for additional Windows and Linux specific notes and quick install snippets

Install Kickstart

[!NOTE] Backup your previous configuration (if any exists)

Neovim's configurations are located under the following paths, depending on your OS:

OS	PATH
Linux, MacOS	$XDG_CONFIG_HOME/nvim, ~/.config/nvim
Windows (cmd)	%localappdata%\nvim\
Windows (powershell)	$env:LOCALAPPDATA\nvim\

Recommended Step

Fork this repo so that you have your own copy that you can modify, then install by cloning the fork to your machine using one of the commands below, depending on your OS.

[!NOTE] Your fork's URL will be something like this: https://github.com/<your_github_username>/kickstart.nvim.git

You likely want to remove lazy-lock.json from your fork's .gitignore file too - it's ignored in the kickstart repo to make maintenance easier, but it's recommended to track it in version control.

Clone kickstart.nvim

[!NOTE] If following the recommended step above (i.e., forking the repo), replace nvim-lua with <your_github_username> in the commands below

Linux and Mac

git clone git@github.com:juanmiguelRuaDev/kickstart.nvim ~/.config/juanmiguelRuaDev/kickstart.nvim

Open Neovim with this config:

NVIM_APPNAME=juanmiguelRuaDev/kickstart.nvim/ nvim

Plugins

colorscheme

• catppuccin/nvim
• folke/tokyonight.nvim

comment

• numToStr/Comment.nvim
• folke/todo-comments.nvim

completion

• hrsh7th/nvim-cmp

debugging

• rcarriga/nvim-dap-ui
• mfussenegger/nvim-dap

editing-support

• windwp/nvim-autopairs
• nvim-treesitter/nvim-treesitter-context

file-explorer

• stevearc/oil.nvim
• nvim-neo-tree/neo-tree.nvim

formatting

• stevearc/conform.nvim

fuzzy-finder

• nvim-telescope/telescope.nvim

git

• lewis6991/gitsigns.nvim
• kdheepak/lazygit.nvim

icon

• nvim-tree/nvim-web-devicons

indent

• lukas-reineke/indent-blankline.nvim

keybinding

• folke/which-key.nvim

lsp

• neovim/nvim-lspconfig
• j-hui/fidget.nvim
• mfussenegger/nvim-lint
• nvimtools/none-ls.nvim

lsp-installer

• williamboman/mason.nvim

nvim-dev

• MunifTanjim/nui.nvim
• nvim-lua/plenary.nvim
• folke/neodev.nvim

plugin-manager

• folke/lazy.nvim

snippet

• rafamadriz/friendly-snippets
• L3MON4D3/LuaSnip

syntax

• echasnovski/mini.surround
• nvim-treesitter/nvim-treesitter-textobjects
• nvim-treesitter/nvim-treesitter

tabline

• akinsho/bufferline.nvim

utility

• echasnovski/mini.nvim

Language Servers

• html
• tflint

[!NOTE] For more information about a particular plugin check its repository's documentation.

This readme was generated by Dotfyle