Walkthrough

  • (NOTE : Make sure you know basic lua , if not then check).
  • Make sure that you read sections in config (in the sidebar of this site) orderwise.

Structure

NvChad comes with the following file / folder structure. An up-to-date & full tree can be viewed in the repo.

  2. ├── init.lua
  3. │
  4. ├── lua
  5. │   │
  6. │   ├── core
  7. │   │   ├── autocmds.lua
  8. │   │   ├── default_config.lua
  9. │   │   ├── mappings.lua
  10. │   │   ├── options.lua
  11. │   │   └── utils.lua (i)
  12. │   │
  13. │   ├── plugins
  14. │   │    ├── init.lua
  15. │   │    ├── packerInit.lua
  16. │   │    └── configs
  17. │   │        ├── bufferline.lua
  18. │   │        ├── others.lua
  19. │   │        └── many more plugin configs
  20. |   |
  21. │   ├── custom *
  22. │   │   ├── chadrc.lua
  23. │   │   ├── init.lua
  24. │   │   ├── more files, dirs
  • The file names in the tree with (i) are meant to be ignored , i.e the user doesn’t need to look at them as the lua code in those files might fret you or look very complex / scare you from NvChad xD.
  • (note) : custom dir has to be created by the user.

Walkthrough

  • Letss goooo!

chad lessgooo

Init.lua

  • NvChads’s config has a lua dir and init.lua.
  • The init.lua basically loads the core config and custom config.
  • pcall is usually used for error handling . Check lua docs for more info.

Themes

  • First copy examples/chadrc.lua to lua/custom/chadrc.lua , make sure it has the theme table
  • <leader> + th (<leader> is <space> in our config)

Mappings

  • :Telescope keymaps

Default general options

  • This file is lua/core/default_config.lua
  • The table below contains all the default options for various stuff in NvChad.

For example :

  1. M.options = {}
  2. M.ui = {}
  3. M.plugins = {}
  4. M.mappings = {} has general mappings

Plugins

  • The lua/plugins dir contains three files, init.lua, packerInit.lua.
  • packerInit.lua : this file is used for defining packer’s init stuff, so things like clone_timeout , compile_on_sync , etc and other packer related options are mentioned here.
  • init.lua : is basically the packer config listing various plugins, it calls packerInit first and then following with definitions of other plugins + their configs’
  • For example to add a plugin , packer uses this format :
  2. ["org or username/reponame"] = {
  3.   config = function()
  4.     path to config ( require it)
  5.   end
  6. }
  8. -- example
  9.  ["max397574/better-escape.nvim"] = {
  10.     config = function()
  11.        require("plugins.configs.better_escape")
  12.     end
  13. }
  15. -- packer's original way of defining plugins : 
  17.  use {
  18.    "max397574/better-escape.nvim",
  19.     config = function()
  20.        require("plugins.configs.better_escape")
  21.     end
  22. }