improve docs

Author: siduck

src/components/doc_comps/Sidebar.tsx

@@ -15,13 +15,12 @@ export const sidebar_Items = [
     label: ["Configure", "i-line-md:cog-filled"],
     items: [
       ["Walkthrough", "config/walkthrough"],
-      ["Snippets", "config/snippets"],
       ["Manage Plugins", "config/plugins"],
-      ["Syntax highlighting", "config/syntax"],
       ["LSP Configuration", "config/lsp"],
       ["Mappings", "config/mappings"],
       ["UI Plugin", "config/nvchad_ui"],
-      ["Customize colors", "config/theming"],
+      ["Theming", "config/theming"],
+      ["Snippets", "config/snippets"],
     ],
   },
 

src/components/docpage/basic.tsx

@@ -0,0 +1,72 @@
+const Basic = () => {
+  return (
+    <section grid="~ md:cols-2 gap3" un-children="3">
+      <div grid="~ gap2" bg="red50 dark:dark3">
+        <div
+          grid="~ cols-3"
+          items-center
+          bg="red2 dark:dark4"
+          p="3 y2"
+          h-fit
+        >
+          <b />
+          <span text="center lg" font="medium">
+            NvChad
+          </span>
+
+          <a href="https://github.com/NvChad/NvChad" ml="auto" target="_blank">
+            <button bg="!slate6" text="white1" rounded="full">
+              <div class="i-ri:link text-sm" />
+            </button>
+          </a>
+        </div>
+
+        <ul>
+          <li>This is the main repo for NvChad and its development.</li>
+
+          <li>It contains all the plugins, options, mappings, autocmds</li>
+
+          <li>
+            All of its modules are in <code>/nvchad</code>
+          </li>
+        </ul>
+      </div>
+
+      <div grid="~ gap2" bg="green50 dark:dark3">
+        <div
+          grid="~ cols-3"
+          items-center
+          bg="green2 dark:dark4"
+          p="3 y2"
+          h-fit
+        >
+          <b />
+          <span text="center lg" font="medium">
+            Starter
+          </span>
+
+          <a href="https://github.com/NvChad/starter" ml="auto" target="_blank">
+            <button bg="!slate6" text="white1" rounded="full">
+              <div class="i-ri:link text-sm" />
+            </button>
+          </a>
+        </div>
+
+        <ul>
+          <li>Config which uses the NvChad repo as a plugin.</li>
+
+          <li>
+            Users will be using the starter config as a base.
+          </li>
+
+          <li>
+            Imports nvchad modules, ex: 
+            <code>require("nvchad.options")</code>.
+          </li>
+        </ul>
+      </div>
+    </section>
+  );
+};
+
+export default Basic;

src/routes/docs/config/mappings.mdx

@@ -23,22 +23,23 @@ The mapping configuration uses the nvim name shortcuts as:
 ```lua 
 local map = vim.keymap.set
 
-map("i", "<C-k>", "<Up>", { desc = "Move up" })
+map("n", "<leader>ff", "<cmd> Telescope <cr>")
 
 -- multiple modes 
-map({ "i", "n" }, "<C-k>", "<Up>", { desc = "Move down" })
-
-map("n", "<leader>ff", ":Telescope <cr>")
+map({ "i", "n" }, "<C-k>", "<Up>", { desc = "Move up" })
 
 -- mapping with a lua function
 map("n", "<A-i>", function()
-  require("nvchad.term").toggle({ pos = "sp", id ='abc' })
+   -- do something
 end, { desc = "Terminal toggle floating" })
 
-
 -- Disable mappings
 local nomap = vim.keymap.del
 
 nomap("i", "<C-k>")
 nomap("n", "<C-k>")
 ```
+
+<br/>
+
+- Do know that lsp & gitsigns mappings wont be overrided by the above methods, because they dont load on startup & are lazy loaded. So put the lsp ones in `LspAttach` autocmd or right after your on_attach

src/routes/docs/config/plugins.mdx

@@ -25,13 +25,14 @@ All NvChad default plugins will have `lazy = true` set. Therefore, if you want a
 local plugins = {
 
   { "elkowar/yuck.vim" , lazy = false },  -- load a plugin at startup
+  { "folke/which-key.nvim",  enabled = false },
 
   -- You can use any plugin specification from lazy.nvim
   {
     "Pocco81/TrueZen.nvim",
     cmd = { "TZAtaraxis", "TZMinimalist" },
     config = function()
-      require "custom.configs.truezen" -- just an example path
+      require "configs.truezen" -- just an example path
     end,
   },
 
@@ -41,12 +42,7 @@ local plugins = {
     opts = {
       ensure_installed = {"html", "css", "bash"},
     },
-  },
-  
-  {
-    "folke/which-key.nvim",
-    enabled = false,
-  },
+  }, 
 
   -- If your opts uses a function call ex: require*, then make opts spec a function
   -- should return the modified default config as well

src/routes/docs/config/syntax.mdx

@@ -1,73 +1,21 @@
+import Basics from "~/components/docpage/basic";
+
 export const meta = {
   title: "NvChad Walkthrough",
   desc: "Walkthrough guide for NvChad"
 }
 
-# How does NvChad work? 
-
-## Understanding the basics
-
-Before getting into the topic, first you should understand the `vim.tbl_deep_extend` function which is used for merging tables and their values recursively.  
-
-- The function `vim.tbl_deep_extend` is normally used to merge 2 tables, and its syntax looks like this: 
-
-```lua
--- table 1
-local person = {
-    name = "joe",
-    age = 19,
-    skills = {"python", "html"},
-}
-
--- table 2
-local someone = {
-    name = "siduck",
-    skills = {"js", "lua"},
-}
-
--- "force" will overwrite equal values from the someone table over the person table
-local result = vim.tbl_deep_extend("force", person, someone)
-
--- result : 
-{
-    name = "siduck",
-    age = 19,
-    skills = {"js", "lua"},
-}
+## How does NvChad work? 
 
--- The list tables wont merge cuz they dont have keys 
-```
+> NvChad's starter repo is the actual config and it uses the main NvChad repo as a plugin
 
-## Main Config Structure
-
- - [NvChad/NvChad](https://github.com/NvChad/NvChad) repo, this contains plugins, options, mappings, autocmds.
- - [NvChad/starter](https://github.com/NvChad/starter) - This is a minimal config which shows how to use the nvchad repo as a plugin.
- - Users will be using the starter config or can create their own
-
- config structure of the main nvchad repo :
-```lua
-├── lua/
-│   ├── nvchad/
-│   │   ├── autocmds.lua
-│   │   ├── mappings.lua
-│   │   └── options.lua
-│   ├── plugins/
-│   │   ├── init.lua
-│   │   └── ui.lua
-│   └── configs/
-│       ├── cmp.lua
-│       └── more.. 
-└── nvconfig.lua  
-```
-<br/>
-- example module import, `require "nvchad.options"`
-- nvconfig.lua is the list of all options for both ui/base46 repo!
+<Basics/>
 
 ## Chadrc.lua
 
-- This file is meant to have structure of [nvconfig.lua](https://github.com/NvChad/NvChad/blob/v2.5/lua/nvconfig.lua), check the nvconfig.lua for knowing all supported options.
-- So nvconfig returns a table of config and then merges chadrc's table.
-- And you put this file in your `/lua` folder
+- This file is used to configure ui & base46 plugin
+- Its meant to have structure of [nvconfig.lua](https://github.com/NvChad/ui/blob/v2.5/lua/nvconfig.lua)
+- It should be in your config's `/lua` folder
 
 ## Themes
 
@@ -81,3 +29,4 @@ If you want to know all the keymaps, you can run the following commands:
 
 - `NvCheatsheet`
 - `Telescope keymaps` 
+

src/routes/docs/config/walkthrough.mdx

@@ -50,6 +50,11 @@ nomap("n", "<tab>")
 
 - You might be using a terminal that doesn't support true color. This problem is very common for those who use the default MacOS terminal, opt to use [iterm2](https://iterm2.com/) instead. 
 
+
+## Syntax highlighting not working
+
+- Make sure you have installed the treesitter parser for the language i.e `TSInstall lua`.
+
 ## CursorLine not showing
 
 - We set it to only number by default, to have cursorline highlight shown, add :

src/routes/docs/faq.mdx

@@ -258,3 +258,36 @@ require("path")
 
 -- both do the same thing
 ```
+
+## vim.tbl_deep_extend
+
+This is a neovim function which is used for merging tables and their values recursively. Most plugins use it for merging config tables.  
+
+```lua
+-- table 1
+local person = {
+    name = "joe",
+    age = 19,
+    skills = {"python", "html"},
+}
+
+-- table 2
+local someone = {
+    name = "siduck",
+    skills = {"js", "lua"},
+}
+
+-- "force" will overwrite equal values from the someone table over the person table
+local result = vim.tbl_deep_extend("force", person, someone)
+
+-- result : 
+{
+    name = "siduck",
+    age = 19,
+    skills = {"js", "lua"},
+}
+
+-- The list tables wont merge cuz they dont have keys 
+```
+<br/>
+- check :h vim.tbl_deep_extend for more info

src/routes/docs/quickstart/learn-lua.mdx

@@ -38,7 +38,9 @@ export const assign_heading_ids = () => {
 
   headingElements?.forEach((item) => {
     item.id = item.innerText.replaceAll(/[ .&]/g, "_").toLowerCase();
-    headings.push([item.localName.toLowerCase(), item.innerText]);
+
+    if (item.className != "nosidebar")
+      headings.push([item.localName.toLowerCase(), item.innerText]);
   });
 
   setHeadings(headings);