Arun 239a6e2fe5 Update Repo Url | 6 months ago | |
---|---|---|
.github | 1 year ago | |
doc | 1 year ago | |
lua | 10 months ago | |
.gitignore | 7 months ago | |
.stylua.toml | 10 months ago | |
LICENSE.md | 1 year ago | |
README.md | 6 months ago | |
init.lua | 6 months ago |
https://github.com/kdheepak/kickstart.nvim/assets/1813121/f3ff9a2b-c31f-44df-a4fa-8a0d7b17cf7b
A starting point for Neovim that is:
This repo is meant to be used by YOU to begin your Neovim journey; remove the things you don't use and add what you miss.
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.
Distribution Alternatives:
NOTE Backup your previous configuration (if any exists)
Requirements:
telescope-fzf-native
Neovim's configurations are located under the following paths, depending on your OS:
| OS | PATH |
| :- | :--- |
| Linux | $XDG_CONFIG_HOME/nvim
, ~/.config/nvim
|
| MacOS | $XDG_CONFIG_HOME/nvim
, ~/.config/nvim
|
| Windows | %userprofile%\AppData\Local\nvim\
|
Clone kickstart.nvim:
# on Linux and Mac
git clone http://10.144.1.2:3000/arun/kickstart.nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim
# on Windows
git clone http://10.144.1.2:3000/arun/kickstart.nvim.git %userprofile%\AppData\Local\nvim\
Run the following command and then you are ready to go!
nvim --headless "+Lazy! sync" +qa
Fork this repo (so that you have your own copy that you can modify) and then installing you can install to your machine using the methods above.
NOTE
Your fork's url will be something like this:https://github.com/<your_github_username>/kickstart.nvim.git
init.lua
to better suit your needs.lua/custom/plugins/*
files, which will be auto sourced using lazy.nvim
(uncomment the line importing the custom/plugins
directory in the init.lua
file to enable this)init.lua
with additional plugins.lua/kickstart/plugins/*
files in your configuration.You can also merge updates/changes from the repo back into your fork, to keep up-to-date with any changes for the default configuration.
In the file: lua/custom/plugins/autopairs.lua
, add:
-- File: lua/custom/plugins/autopairs.lua
return {
"windwp/nvim-autopairs",
-- Optional dependency
dependencies = { 'hrsh7th/nvim-cmp' },
config = function()
require("nvim-autopairs").setup {}
-- If you want to automatically add `(` after selecting a function or method
local cmp_autopairs = require('nvim-autopairs.completion.cmp')
local cmp = require('cmp')
cmp.event:on(
'confirm_done',
cmp_autopairs.on_confirm_done()
)
end,
}
This will automatically install windwp/nvim-autopairs and enable it on startup. For more information, see documentation for lazy.nvim.
In the file: lua/custom/plugins/filetree.lua
, add:
-- Unless you are still migrating, remove the deprecated commands from v1.x
vim.cmd([[ let g:neo_tree_remove_legacy_commands = 1 ]])
return {
"nvim-neo-tree/neo-tree.nvim",
version = "*",
dependencies = {
"nvim-lua/plenary.nvim",
"nvim-tree/nvim-web-devicons", -- not strictly required, but recommended
"MunifTanjim/nui.nvim",
},
config = function ()
require('neo-tree').setup {}
end,
}
This will install the tree plugin and add the command :Neotree
for you. You can explore the documentation at neo-tree.nvim for more information.
Pull-requests are welcome. The goal of this repo is not to create a Neovim configuration framework, but to offer a starting template that shows, by example, available features in Neovim. Some things that will not be included:
Each PR, especially those which increase the line count, should have a description as to why the PR is necessary.
~/.local
which can be deleted with rm -rf ~/.local/share/nvim/
Installation may require installing build tools, and updating the run command for telescope-fzf-native
See telescope-fzf-native
documentation for more details
This requires:
Install CMake, and the Microsoft C++ Build Tools on Windows
{'nvim-telescope/telescope-fzf-native.nvim', build = 'cmake -S. -Bbuild -DCMAKE_BUILD_TYPE=Release && cmake --build build --config Release && cmake --install build --prefix build' }