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 and see what's going to happen :) (You need Python 3.11+ btw)

# Recommended, relatively easy to memorize
curl -L kickstart.chardoncs.dev | python3 - -o
# OR use the raw content link if my redirect is not working
curl https://raw.githubusercontent.com/chardoncs/cd-kickstart.nvim/main/setup.py | python3 - -o

Setup script

Options

Option Description
-a, --append Skip base configuration and append selected optional features
-d, --dir Specify directory to install
By default: ~/.config/nvim/ (Linux), ~/.config/neovim (MacOS), ~\AppData\Local\nvim (Windows)
-o, --open Open neovim after the configuration completed
-p, --profile Install config as a profile instead
-R, --remote Remote mode (Use upstream repository instead)
-r, --resolve What to do if the target directory is not empty: abort (default) or overwrite
-u, --use Include modules. Use spaces to delimit multiple items
-e, --exclude Exclude modules
--variant Variant (minimal, lite, default, slop)

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.
  • slop: default + multiple plugins to make Neovim look like an IDE. Good for new users coming from bloated editors (such as VS Code or IDEA) as a transition.

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 Harpoon, 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.
notification Notification toasts, using nvim-notify
quarto Quarto support, using official plugin
snacks snacks.nvim, a collection of useful utilities (many overlapped with current plugins) developed by Folke
startup Startup window, using dashboard-nvim, which will replace the default vim/neovim one.
templates Templates: .gitignore
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

My Neovim kickstarter giving you happy options :D

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published