docs: updated docs. Fixes #667

lua/lazy/example.lua

@@ -18,30 +18,22 @@ return {
     "nvim-neorg/neorg",
     -- lazy-load on filetype
     ft = "norg",
-    -- custom config that will be executed when loading the plugin
-    config = function()
-      require("neorg").setup()
-    end,
-  },
-
-  -- the above could also be written as:
-  {
-    "nvim-neorg/neorg",
-    ft = "norg",
-    config = true, -- run require("neorg").setup()
-  },
-
-  -- or set custom options:
-  {
-    "nvim-neorg/neorg",
-    ft = "norg",
-    opts = { foo = "bar" }, -- run require("neorg").setup({foo = "bar"})
+    -- options for neorg. This will automatically call `require("neorg").setup(opts)`
+    opts = {
+      load = {
+        ["core.defaults"] = {},
+      },
+    },
   },
 
   {
     "dstein64/vim-startuptime",
     -- lazy-load on a command
     cmd = "StartupTime",
+    -- init is called during startup. Configuration for vim plugins typically should be set in an init function
+    init = function()
+      vim.g.startuptime_tries = 10
+    end,
   },
 
   {
@@ -59,19 +51,20 @@ return {
     end,
   },
 
+  -- if some code requires a module from an unloaded plugin, it will be automatically loaded.
+  -- So for api plugins like devicons, we can always set lazy=true
+  { "nvim-tree/nvim-web-devicons", lazy = true },
+
   -- you can use the VeryLazy event for things that can
   -- load later and are not important for the initial UI
   { "stevearc/dressing.nvim", event = "VeryLazy" },
 
   {
-    "cshuaimin/ssr.nvim",
-    -- init is always executed during startup, but doesn't load the plugin yet.
-    init = function()
-      vim.keymap.set({ "n", "x" }, "<leader>cR", function()
-        -- this require will automatically load the plugin
-        require("ssr").open()
-      end, { desc = "Structural Replace" })
-    end,
+    "Wansmer/treesj",
+    keys = {
+      { "J", "<cmd>TSJToggle<cr>", desc = "Join Toggle" },
+    },
+    opts = { use_default_keymaps = false, max_join_length = 150 },
   },
 
   {