A launch point for your personal nvim configuration
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Go to file
Juan Miguel Rua 604b0a52a9 update nvim with upstream 3 months ago
.github chore: fix typo in bug report issue template (#1306) 6 months ago
doc feat: move to lazy.nvim package manager and add first plugins (#178) 2 years ago
lua update nvim with upstream 3 months ago
.gitignore rewrite: slimmer, trimmer and more lazy kickstart.nvim (#635) 1 year ago
.stylua.toml Use call_parentheses 2 years ago
LICENSE.md license 3 years ago
README.md update nvim with upstream 3 months ago
init.lua update nvim with upstream 3 months ago

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\

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

comment

completion

debugging

editing-support

file-explorer

formatting

fuzzy-finder

git

icon

indent

keybinding

lsp

lsp-installer

nvim-dev

plugin-manager

snippet

syntax

tabline

utility

Language Servers

  • html
  • tflint

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

This readme was generated by Dotfyle