Skip to content

chardoncs/cd-kickstart.nvim

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Charles' Neovim Kickstarter

Kick start your Neovim with options to choose.

Why another kickstarter?

Quick start

Copy and execute this command (btw you need Python 3)

curl -fsSL kickstart.chardoncs.dev/setup.py | python3

or simply

curl -fsSL kickstart.chardoncs.dev | python3

Setup script

Options

Option Description
-a, --append Skip base configuration and append selected optional features
-A, --apply Update the destination file/directory to the latest state
-d, --dir Specify directory to install
By default: ~/.config/nvim (POSIX), ~\AppData\Local\nvim (Windows)
-f, --force Skip confirmation / enforce overwriting files
-n, --no-open Do not launch Neovim after the configuration completed
-p, --profile Install config as a profile instead
-R, --remote Remote mode (Use upstream repository instead)
-u, --use Include modules. Use spaces to delimit multiple items
-e, --exclude Exclude modules
--variant Variant (minimal, lite, default, full)

Variants

  • minimal: Only basic configurations and lazy.nvim. Good for users who just want a foundation for their customizations.
  • lite: minimal + basic plugins (Telescope, Tree-sitter configs, themes, etc.). Near-lightweight experience.
  • default: lite + basic LSP config, Lualine, and Nerd Fonts. My go-to choices. Suitable for most tasks without getting too bloated.
  • full: default + multiple plugins to make Neovim look like an IDE. Good for new users coming from VS Code or IDEA as a transition.

Optional Modules

Module Description
dbee nvim-dbee, a database client
flutter Flutter support, using flutter-tools.nvim
hardtime Establish good command workflow habits using hardtime.nvim
NOTE: You might feel uncomfortable with it since multiple functionalities (like mouse selection, arrow keys) are disabled.
harpoon ThePrimeagen's Harpoon, an opinionated tool for switching between buffers without using a tabline or bufferline
mason LSP server management, using mason.nvim.
Otherwise, LSP servers must be managed manually or using the system package manager, and configured manually in lua/plugins/lsp.lua.
neotest Neotest, a unit test interaction framework
notification Notification toasts, using nvim-notify
nvim-tree nvim-tree, a file explorer tree
quarto Quarto support, using official plugin
snacks snacks.nvim, a collection of useful utilities (many overlapped with current plugins) developed by Folke
sonarlint SonarQube linter support using sonarlint.nvim.
NOTE: Java Runtime is required for running SonarLint.
startup Startup window, using dashboard-nvim, which will replace the default vim/neovim one.
tex TeX/LaTeX support, using VimTeX, and telescope-bibtex.nvim for Telescope BibTeX search

Additional setups

LuaRocks

I personally don't use LuaRocks for Neovim. To allow Lazy.nvim using LuaRocks, set rocks.enabled to true in lua/lazy_setup.lua

About

kinda opinionated (or not) Neovim kickstarter

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published