docs: added comments to config files

diff --git a/lua/config/autocmds.lua b/lua/config/autocmds.lua
new file mode 100644 (file)
index 0000000..27e9e06
--- /dev/null
+++ b/lua/config/autocmds.lua
@@ -0,0 +1,3 @@
+-- Autocmds are automatically loaded on the VeryLazy event
+-- Default autocmds that are always set: https://github.com/LazyVim/LazyVim/blob/main/lua/lazyvim/config/autocmds.lua
+-- Add any additional autocmds here

diff --git a/lua/config/keymaps.lua b/lua/config/keymaps.lua
new file mode 100644 (file)
index 0000000..2c134f7
--- /dev/null
+++ b/lua/config/keymaps.lua
@@ -0,0 +1,3 @@
+-- Keymaps are automatically loaded on the VeryLazy event
+-- Default keymaps that are always set: https://github.com/LazyVim/LazyVim/blob/main/lua/lazyvim/config/keymaps.lua
+-- Add any additional keymaps here

diff --git a/lua/config/lazy.lua b/lua/config/lazy.lua
index 2e00452c4f3a20cf40f14ed3e2eb8fdd9f675809..9208df7f3a953ef33620b5234ea0b40e6d577a3f 100644 (file)
--- a/lua/config/lazy.lua
+++ b/lua/config/lazy.lua
@@ -1,26 +1,27 @@
 local lazypath = vim.fn.stdpath("data") .. "/lazy/lazy.nvim"
 if not vim.loop.fs_stat(lazypath) then
-  vim.fn.system({
-    "git",
-    "clone",
-    "--filter=blob:none",
-    "https://github.com/folke/lazy.nvim.git",
-    "--branch=stable",
-    lazypath,
-  })
+  -- bootstrap lazy.nvim
+  -- stylua: ignore
+  vim.fn.system({ "git", "clone", "--filter=blob:none", "https://github.com/folke/lazy.nvim.git", "--branch=stable", lazypath })
 end
 vim.opt.rtp:prepend(vim.env.LAZY or lazypath)
 
 require("lazy").setup({
   spec = {
+    -- import LazyVim plugins
     { "LazyVim/LazyVim", import = "lazyvim.plugins" },
+    -- import/override with your plugins
     { import = "plugins" },
   },
-  defaults = { lazy = true },
+  defaults = {
+    lazy = true, -- every plugin is lazy-loaded by default
+    version = "*", -- try installing the latest stable version for plugins that support semver
+  },
   install = { colorscheme = { "tokyonight", "habamax" } },
-  checker = { enabled = true },
+  checker = { enabled = true }, -- automatically check for plugin updates
   performance = {
     rtp = {
+      -- disable some rtp plugins
       disabled_plugins = {
         "gzip",
         "matchit",

diff --git a/lua/config/options.lua b/lua/config/options.lua
new file mode 100644 (file)
index 0000000..3ea1454
--- /dev/null
+++ b/lua/config/options.lua
@@ -0,0 +1,3 @@
+-- Options are automatically loaded before lazy.nvim startup
+-- Default options that are always set: https://github.com/LazyVim/LazyVim/blob/main/lua/lazyvim/config/options.lua
+-- Add any additional options here