diff --git a/docs/assets/css/extra.css b/docs/assets/css/extra.css index ae4f360..b398118 100644 --- a/docs/assets/css/extra.css +++ b/docs/assets/css/extra.css @@ -1,15 +1,64 @@ -.welcome { +/* h --> heading */ +/* sh --> sub heading */ + +/* mh --> main heading */ +/* msh --> main sub heading */ + +/* th --> topic heading */ +/* tsh --> topic sub heading */ + +.h-font { + font-size: 2.5rem; + font-weight: 900; +} + +.sh-font { + font-weight: 800; + font-size: 1.3rem; +} + +.mh-color { background: linear-gradient(to right, #0076D8, #FF5CFF); /* Gradient colors */ -webkit-background-clip: text; color: transparent; } -.pages-heading { +.msh-color { + -webkit-background-clip: text; + background-clip: text; + color: transparent; + background-image: linear-gradient(to bottom right, #76b6ef, #d597e8, #f8919a); +} + +/* Light mode color for .msh-color */ +[data-md-color-scheme="default"] .msh-color { + background-image: linear-gradient(to bottom right, #1b86e4, #b343d6, #f33f4e); +} + +.th-color { background: linear-gradient(to right, #FF5C5C, #FF9B21); /* Gradient colors */ -webkit-background-clip: text; color: transparent; } -.sub-heading { - color: orange; +.tsh-color { + -webkit-background-clip: text; + background-clip: text; + color: transparent; + /*background-image: linear-gradient(to bottom right, #FFC55C, #F29C9E, #FFFF8A);*/ + background-image: linear-gradient(to bottom right, #ffd9b3, #ffa64d, #ffd9b3); +} + +/* Light mode color for .tsh-color */ +[data-md-color-scheme="default"] .tsh-color { + background-image: linear-gradient(to bottom right, #994d00, #ff9933, #994d00); +} + +.pl-font { + font-weight: 500; + font-size: 1.3rem; +} + +.blue-color { + color: #4d8dc5; } diff --git a/docs/features.md b/docs/features.md index 383a4cb..06f45b9 100644 --- a/docs/features.md +++ b/docs/features.md @@ -1,44 +1,44 @@
-

Features of GarudaNvim

+

Features of GarudaNvim

GarudaNvim is more than just another Neovim setup – it’s a finely tuned machine built for those who want to code, not configure. From productivity-boosting keymaps to eye-pleasing themes, GarudaNvim takes Neovim to new heights. Dive in to see what makes it tick: --- -## Effortless Installation +## Effortless Installation - **Automatic Setup, Minimal Hassle:** Our installer handles everything from OS detection to plugin setup, leaving you more time to focus on your code and less time wondering why things don’t work. - **Cross-Platform Magic:** Whether you’re on macOS or Linux, GarudaNvim's installer is as compatible as the most versatile coder. One run, and it’s all set up – no more wrestling with dependencies. -## Productivity Powerhouse +## Productivity Powerhouse - **Shortcut Wizardry:** With GarudaNvim’s custom keymaps, you’ll forget what “slow” feels like. Jump between files, split windows, resize buffers – it’s all a keystroke away. Less typing, more coding. - **Which-Key Guidance:** With Which-Key as your guide, every possible keybinding is right at your fingertips. No more + ??? guessing games – just press, discover, and power up. -## Enhanced Navigation +## Enhanced Navigation - **Telescope for Search-Anything:** Need to find a file, buffer, or command? Telescope integration lets you glide through your project faster than a Ctrl+F on steroids. Say goodbye to scrolling aimlessly. - **NvimTree for File Management:** A built-in, intuitive file explorer keeps all your files accessible with a simple shortcut. Navigate like a pro without ever leaving Neovim’s window. -## Customizable UI Elements +## Customizable UI Elements - **Polished Status and Tab Lines:** With **Lualine** for the statusline and **Barbar** for the tabline, you get a sleek, customizable interface that keeps tabs on your workflow without becoming a cluttered mess. - **Eye-Friendly Highlights:** Each highlight color and cursorline has been meticulously chosen to ensure comfort, visibility, and minimal eye strain – because staring at code all day is already hard enough. -## Multiple Themes Built In +## Multiple Themes Built In - **Color Schemes for Every Mood:** With options like **Tokyo Night**, **Nordic**, **Dracula**, **Catppuccin**, and more, you can match your Neovim vibes with your monitor brightness (or your mood, no judgment here). - **Light and Dark Mode Toggle:** A single command flips the theme, so you can go from night owl to daylight coder without skipping a beat. -## Seamless Plugin Management +## Seamless Plugin Management - **Lazy for Effortless Plugin Control:** Why “install manually” when you can “install lazily”? With the **Lazy** plugin manager, adding, updating, or removing plugins is as effortless as a lazy Sunday. - **Curated Essentials:** Hand-picked plugins for maximum productivity – from **Onedarkpro** for a pleasing default theme to **Telescope** for instant file searching. Only the best make the cut. -## Minimal Yet Expandable +## Minimal Yet Expandable - **Core Setup, Endless Potential:** GarudaNvim starts minimal so you can build up as needed. Want a bare-bones environment? Done. Want to add your own collection of plugins and tweak everything? Go wild. - **Easy Customization:** Adjust options, add new plugins, or play around with settings without having to unearth cryptic files. The setup is designed to be as flexible as a Neovim enthusiast’s ideal config. -## Detailed Documentation +## Detailed Documentation - **Knowledge At Your Fingertips:** Whether you’re a Neovim newbie or a seasoned coder, the GarudaNvim Docs cover everything you need to know, from installation to mastering every shortcut. No need to trawl forums for answers. - **Example-Rich Explanations:** Real examples, quick tips, and straightforward instructions ensure that you spend more time coding and less time deciphering docs. -## Updates and Feedback +## Updates and Feedback - **Constant Updates and Improvements:** GarudaNvim is a passion project by Priyanshu Ranjan, supported by a growing community of Neovim enthusiasts. Expect regular improvements, fresh features, and feedback-driven updates. - **Built by Coders, for Coders:** GarudaNvim grows with the feedback of real-world usage, so everything here is designed with developers' needs in mind. diff --git a/docs/index.md b/docs/index.md index 54a2339..8e78e83 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,6 @@

- Welcome to GarudaNvim + Welcome to GarudaNvim

GarudaNvim Logo -## **Introduction** +## Introduction Reimagining how you code! @@ -25,7 +25,7 @@ Here's what we have got for you! --- -## **Why GarudaNvim?** +## Why GarudaNvim? It’s simple: speed, agility, and an obsession with keyboard shortcuts. @@ -41,7 +41,7 @@ Ready To Install? Click [here](installation.md) --- -## **Vision** +## Vision Imagine a world where configuring your editor doesn’t feel like defusing a bomb. GarudaNvim’s mission is to bring you a robust, ready-to-go Neovim setup that’s customizable, lightweight, and fast enough to rival even the fanciest GUI editors. Whether you’re a seasoned Vim wizard or a Neovim newcomer, GarudaNvim provides the tools and configurations needed for an exceptional coding experience. @@ -49,7 +49,7 @@ GarudaNvim isn’t just a Neovim config – it’s a philosophy. It’s about co --- -## **Latest Version: v1.2.0** +## Latest Version: v1.2.0 Yes, we keep it fresh! **v1.2.0** is out and packing some serious heat: @@ -60,7 +60,7 @@ Because let's be honest – you didn’t really want to write all those colorsch --- -## **Support Us** +## Support Us If GarudaNvim has saved you from a dozen mouse-induced wrist injuries, consider giving it a star ⭐ on GitHub! It’s a small click for you, but it means the world to us. @@ -68,13 +68,13 @@ And if you’re feeling extra generous, you can [sponsor the project](https://gi --- -## **Acknowledgements** +## Acknowledgements Big thanks to [Neovim](https://github.com/neovim/neovim) for making terminal-based coding awesome (and for the endless possibilities of `:q!`). And to the creators of all the plugins we rely on – we owe you a whole lot of coffees and an embarrassing number of pull requests. --- -## **Last Words...** +## Last Words... Happy Coding with GarudaNvim 💻
Welcome to the Cult (oh sorry, I meant Club) diff --git a/docs/installation.md b/docs/installation.md index 87a5b70..bd8b80a 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -1,10 +1,10 @@
-

Installation

+

Installation

Installing GarudaNvim is a breeze. Follow the steps below to get GarudaNvim up and running on your machine. -## Installation Command +## Installation Command Run the following command to install GarudaNvim on your system: @@ -17,7 +17,7 @@ rm -f installGarudaNvim.sh
-## Uninstallation +## Uninstallation To uninstall GarudaNvim, use the command below: diff --git a/docs/keymaps.md b/docs/keymaps.md index 3eee016..f7642d6 100644 --- a/docs/keymaps.md +++ b/docs/keymaps.md @@ -1,12 +1,12 @@
-

Keymaps

+

Keymaps

*Welcome to the land of keymaps, where every keystroke counts, and Neovim becomes your playground. We know you're here because you're tired of typing the same old commands a thousand times a day. Well, you've come to the right place! With GarudaNvim's custom keymaps, we’re putting your fingers on the fast lane to efficiency. But before you start flying through your code, remember: with great power comes great responsibility. Use these keybindings wisely, or you might just get too lazy to use the mouse again. No pressure, though.* Also, don't forget that *this is just the beginning.* After mastering these, head over to the **which-key** page—our beloved menu of shortcuts. Trust us, it’ll make you feel like a coding ninja, minus the actual ninja suit.* -### Neovim Modes +## Neovim Modes - **Normal Mode** (`n`): The default mode for most actions, like navigating, editing, and breaking stuff (whoops). - **Insert Mode** (`i`): Where you go when you need to type things (or mess up an entire file). - **Visual Mode** (`v`): Selecting text to either copy, delete, or wonder why you selected it in the first place. @@ -16,7 +16,7 @@ Also, don't forget that *this is just the beginning.* After mastering these, hea --- -### General Setup +## General Setup - **Leader Key**: GarudaNvim uses the space bar (``) as the leader key. It’s the most powerful key on your keyboard now, so treat it with respect. Here's how it's mapped: ```lua @@ -27,7 +27,7 @@ Also, don't forget that *this is just the beginning.* After mastering these, hea --- -### Keymaps in Normal Mode +## Keymaps in Normal Mode Welcome to normal mode, where the magic happens, and where most of your day will be spent. @@ -88,7 +88,7 @@ Welcome to normal mode, where the magic happens, and where most of your day will --- -### Keymaps in Insert Mode +## Keymaps in Insert Mode Insert mode: for the brave, the bold, and those who actually need to type things. @@ -115,7 +115,7 @@ Insert mode: for the brave, the bold, and those who actually need to type things --- -### Keymaps in Visual Mode +## Keymaps in Visual Mode Visual mode: where selection happens, and text manipulation gets real. @@ -145,7 +145,7 @@ Visual mode: where selection happens, and text manipulation gets real. --- -### Keymaps in Visual Block Mode +## Keymaps in Visual Block Mode For when you need to manipulate columns of text like a true hacker. @@ -158,6 +158,6 @@ For when you need to manipulate columns of text like a true hacker. --- -### Additional Customization +## Additional Customization GarudaNvim allows you to modify or extend these keymaps based on your workflow. We believe in the power of personalization. If these aren’t enough, feel free to dive into the `keymaps.lua` file and add more. diff --git a/docs/plugins.md b/docs/plugins.md index 5d4f23c..7545243 100644 --- a/docs/plugins.md +++ b/docs/plugins.md @@ -1,12 +1,13 @@
-

Plugins

+

Plugins

GarudaNvim comes pre-installed with a range of powerful plugins to maximize productivity, enhance workflow, and streamline your Neovim experience. Below is a list of the most important plugins included in GarudaNvim, ranked by their significance. --- -## 1. **nvim-tree.lua** +## 1. nvim-tree.lua + **File Explorer** **Repository:** [nvim-tree/nvim-tree.lua](https://github.com/nvim-tree/nvim-tree.lua) @@ -14,7 +15,8 @@ A highly efficient file explorer that integrates seamlessly into Neovim. With nv --- -## 2. **telescope.nvim** +## 2. telescope.nvim + **Fuzzy Finder** **Repository:** [nvim-telescope/telescope.nvim](https://github.com/nvim-telescope/telescope.nvim) @@ -22,7 +24,8 @@ Telescope is a flexible and feature-rich fuzzy finder. It allows you to quickly --- -## 3. **barbar.nvim** +## 3. barbar.nvim + **Tabline** **Repository:** [romgrk/barbar.nvim](https://github.com/romgrk/barbar.nvim) @@ -30,7 +33,8 @@ Barbar provides a sleek tabline that allows easy navigation between buffers in N --- -## 4. **lualine.nvim** +## 4. lualine.nvim + **Statusline** **Repository:** [nvim-lualine/lualine.nvim](https://github.com/nvim-lualine/lualine.nvim) @@ -38,7 +42,8 @@ Lualine is a fast, lightweight statusline plugin for Neovim, offering flexibilit --- -## 5. **alpha-nvim** +## 5. alpha-nvim + **Dashboard** **Repository:** [goolord/alpha-nvim](https://github.com/goolord/alpha-nvim) @@ -46,7 +51,8 @@ Alpha provides a customizable dashboard that appears when you start Neovim. You --- -## 6. **project.nvim** +## 6. project.nvim + **Project Management** **Repository:** [ahmedkhalf/project.nvim](https://github.com/ahmedkhalf/project.nvim) @@ -54,7 +60,8 @@ This plugin helps manage and quickly switch between different projects on your m --- -## 7. **which-key.nvim** +## 7. which-key.nvim + **Keybinding Helper** **Repository:** [folke/which-key.nvim](https://github.com/folke/which-key.nvim) @@ -62,7 +69,8 @@ Which-key helps you learn and remember keybindings by displaying available key m --- -## 8. **gitsigns.nvim** +## 8. gitsigns.nvim + **Git Integration** **Repository:** [lewis6991/gitsigns.nvim](https://github.com/lewis6991/gitsigns.nvim) @@ -70,7 +78,8 @@ Gitsigns displays git status indicators in the sign column, allowing you to view --- -## 9. **toggleterm.nvim** +## 9. toggleterm.nvim + **Terminal Management** **Repository:** [akinsho/toggleterm.nvim](https://github.com/akinsho/toggleterm.nvim) @@ -78,7 +87,8 @@ Toggleterm makes managing multiple terminal instances within Neovim easy. It all --- -## 10. **lazygit.nvim** +## 10. lazygit.nvim + **Git Interface** **Repository:** [kdheepak/lazygit.nvim](https://github.com/kdheepak/lazygit.nvim) @@ -86,7 +96,8 @@ This plugin integrates the popular LazyGit terminal UI into Neovim, enabling you --- -## 11. **nvim-web-devicons** +## 11. nvim-web-devicons + **File Icons** **Repository:** [nvim-tree/nvim-web-devicons](https://github.com/nvim-tree/nvim-web-devicons) @@ -94,7 +105,8 @@ Nvim-web-devicons provides file icons that enhance the appearance of various plu --- -## 12. **telescope-ui-select.nvim** +## 12. telescope-ui-select.nvim + **UI Select Integration** **Repository:** [nvim-telescope/telescope-ui-select.nvim](https://github.com/nvim-telescope/telescope-ui-select.nvim) @@ -102,7 +114,8 @@ This plugin extends telescope by integrating with Neovim’s `vim.ui.select()` f --- -## 13. **telescope-live-grep-args.nvim** +## 13. telescope-live-grep-args.nvim + **Grep with Arguments** **Repository:** [nvim-telescope/telescope-live-grep-args.nvim](https://github.com/nvim-telescope/telescope-live-grep-args.nvim) @@ -110,7 +123,8 @@ Telescope-live-grep-args allows you to pass arguments to `live_grep`, providing --- -## 14. **plenary.nvim** +## 14. plenary.nvim + **Utility Library** **Repository:** [nvim-lua/plenary.nvim](https://github.com/nvim-lua/plenary.nvim) diff --git a/docs/themes.md b/docs/themes.md index 3199b9e..2dce5bd 100644 --- a/docs/themes.md +++ b/docs/themes.md @@ -1,13 +1,13 @@
-

Themes

+

Themes

GarudaNvim allows you to switch between themes and customize the look of your editor. -### Default Themes +## Default Themes - **Onedarkpro**: A sleek dark theme that enhances code visibility. -### Available Themes +## Available Themes Pick the one you like most. - Dracula @@ -17,9 +17,11 @@ Pick the one you like most. - Catppuccin - Nightfox -### Customizing Themes +## Customizing Themes To customize the theme, modify the respective configuration file at: -`~/.config/nvim/lua/garudanvim/plugin_config/color_config/` +``` +~/.config/nvim/lua/garudanvim/plugin_config/color_config/ +```
In this file, you can change colors, contrasts, and more to match your preference. diff --git a/docs/whichkey.md b/docs/whichkey.md index 859dbf7..9fc82fe 100644 --- a/docs/whichkey.md +++ b/docs/whichkey.md @@ -1,5 +1,5 @@
-

Which-Key Keybindings

+

Which-Key Keybindings

Welcome to the secret stash of keybindings that revolve around everyone's favorite key—the space key! If you thought the keymaps file was all there is to GarudaNvim’s superpowers, well, think again. @@ -8,7 +8,7 @@ This is the page where we take the humble `space` key and transform it into your Take a deep breath, grab your coffee, and dive in—each keybinding has been placed with the precision of a seasoned developer trying to avoid a merge conflict. You might not even realize how badly you needed these shortcuts until you try them. Seriously, give them a shot. And don’t worry, the space key isn’t overloaded like your browser’s open tabs. It’s just filled with shortcuts that will make you wonder how you ever coded without them. -## Keybindings List +## Keybindings List ### General Shortcuts - ` e`: Toggle NvimTree (File Explorer) @@ -85,7 +85,7 @@ Take a deep breath, grab your coffee, and dive in—each keybinding has been pla - ` z t`: Switch colorschemes using Telescope - ` z h`: Check Neovim health -## Additional Notes from the Which-Key Setup +## Additional Notes from the Which-Key Setup The **Which-Key** plugin has been configured to provide a clear and helpful interface for key mappings, enhancing productivity with the following features: