|
1 | | -### KhulnaSoft's init.lua |
2 | | -Prerequisite: install [ripgrep](https://github.com/BurntSushi/ripgrep). |
| 1 | +# KhulnaSoft’s `init.lua` — Your Next-Level Neovim Setup |
3 | 2 |
|
4 | | -For anyone that is interested in my vimrc, i will have a commit log below |
5 | | -documenting each one of my commits (easy to C-f the change you want to know |
6 | | -about though i would just suggest `git log -S`). |
| 3 | +--- |
| 4 | + |
| 5 | +## Prerequisites |
| 6 | + |
| 7 | +- **Neovim 0.8+** — Ensure you have the latest stable Neovim installed. |
| 8 | +- **ripgrep** — Install [ripgrep](https://github.com/BurntSushi/ripgrep#installation), a blazing-fast search tool that enhances Neovim’s searching capabilities. |
| 9 | +- **Git** — For cloning and updating this configuration. |
| 10 | + |
| 11 | +--- |
| 12 | + |
| 13 | +## Installation Guide |
| 14 | + |
| 15 | +### 1. Clone This Repository |
| 16 | + |
| 17 | +```bash |
| 18 | +git clone https://github.com/your-username/khulnasoft-init.lua.git ~/.config/nvim |
| 19 | +``` |
| 20 | + |
| 21 | +*(Replace `your-username` with your GitHub username if applicable.)* |
| 22 | + |
| 23 | +### 2. Launch Neovim |
| 24 | + |
| 25 | +Run: |
| 26 | + |
| 27 | +```bash |
| 28 | +nvim |
| 29 | +``` |
| 30 | + |
| 31 | +On the first launch, this config will bootstrap and install all required plugins automatically. |
| 32 | + |
| 33 | +### 3. Sync Plugins Manually (Optional) |
| 34 | + |
| 35 | +If you want to manually update or install plugins, use: |
| 36 | + |
| 37 | +```vim |
| 38 | +:PackerSync |
| 39 | +``` |
| 40 | + |
| 41 | +*(Or the equivalent command if you use another plugin manager.)* |
| 42 | + |
| 43 | +--- |
| 44 | + |
| 45 | +## Features |
| 46 | + |
| 47 | +- **Treesitter-Powered Syntax Highlighting & Folding** |
| 48 | + Fast, accurate syntax highlighting and smart code folding based on syntax trees. |
| 49 | + |
| 50 | +- **Smart Formatting with Conform.nvim** |
| 51 | + Format code intelligently on demand or on save, leveraging Treesitter for precise ranges. |
| 52 | + |
| 53 | +- **Custom Keymaps & Workflow Enhancements** |
| 54 | + Streamlined keybindings to speed up navigation, searching, and refactoring. |
| 55 | + |
| 56 | +- **Built-in Git Integration** |
| 57 | + See changes, stage hunks, and navigate commits all within Neovim. |
| 58 | + |
| 59 | +- **LSP and Autocompletion Support** |
| 60 | + Out-of-the-box Language Server Protocol setup with `nvim-cmp` autocompletion. |
| 61 | + |
| 62 | +- **Light & Dark Theme Support** |
| 63 | + Choose your favorite colorscheme or switch themes dynamically. |
| 64 | + |
| 65 | +--- |
| 66 | + |
| 67 | +## Why Follow the Commits? |
| 68 | + |
| 69 | +Curious about how or why something changed? |
| 70 | +This repository has a **detailed commit history** documenting every tweak and improvement. Use the command below to quickly search commits related to any keyword or feature: |
| 71 | + |
| 72 | +```bash |
| 73 | +git log -S '<your-keyword-here>' |
| 74 | +``` |
| 75 | + |
| 76 | +This helps you: |
| 77 | + |
| 78 | +- Understand the reasoning behind changes |
| 79 | +- Discover new tricks and config tips |
| 80 | +- Adapt ideas into your own setup |
| 81 | + |
| 82 | +--- |
| 83 | + |
| 84 | +## Customize Your Setup |
| 85 | + |
| 86 | +This configuration is modular and designed for easy customization. You can tailor: |
| 87 | + |
| 88 | +- Plugin list and configurations |
| 89 | +- Keybindings |
| 90 | +- Language servers and formatters |
| 91 | +- Themes and UI tweaks |
| 92 | + |
| 93 | +Explore the `lua/khulnasoft/` directory to get started. |
| 94 | + |
| 95 | +--- |
| 96 | + |
| 97 | +## Troubleshooting & Tips (Optional) |
| 98 | + |
| 99 | +- If plugins don’t load properly, try running `:PackerSync` again. |
| 100 | +- Ensure you have a compatible version of Neovim (0.8 or newer). |
| 101 | +- Use `:checkhealth` in Neovim to diagnose potential issues. |
| 102 | +- Join Neovim communities on Discord or Reddit for more help! |
| 103 | + |
| 104 | +--- |
| 105 | + |
| 106 | +Feel free to open issues or submit pull requests if you want to suggest improvements or report bugs. |
| 107 | + |
| 108 | +Happy coding! 🚀 |
0 commit comments