diff --git a/docs/assets/css/extra.css b/docs/assets/css/extra.css index 8f52944..ae4f360 100644 --- a/docs/assets/css/extra.css +++ b/docs/assets/css/extra.css @@ -1,5 +1,15 @@ -spam { +.welcome { background: linear-gradient(to right, #0076D8, #FF5CFF); /* Gradient colors */ -webkit-background-clip: text; color: transparent; } + +.pages-heading { + background: linear-gradient(to right, #FF5C5C, #FF9B21); /* Gradient colors */ + -webkit-background-clip: text; + color: transparent; +} + +.sub-heading { + color: orange; +} diff --git a/docs/features.md b/docs/features.md index 42cb156..383a4cb 100644 --- a/docs/features.md +++ b/docs/features.md @@ -1,22 +1,47 @@ -# **Features of GarudaNvim** +
+

Features of GarudaNvim

+
-GarudaNvim is designed to provide a minimalist, yet highly efficient, Neovim experience. Here are some of the top features that make GarudaNvim stand out: +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: -## Keymaps -- Custom keymaps that allow for faster navigation, editing, and window management. -- Optimized shortcuts for splitting windows, resizing, and switching buffers. +--- -## Plugin Management -- Integrated **Lazy** plugin manager for streamlined plugin installations. -- **NvimTree** for file exploration and **Onedarkpro** for a beautiful default theme. +## 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. -## Themes and Customization -- Easily switch between light and dark modes. -- Modify themes with built-in customization options. +## 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 +- **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. -## Cross-Platform Compatibility -- Compatible with **macOS** and **Linux** distributions. -- Installer automatically detects your OS and installs dependencies. +## 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. -[Explore Keymaps](keymaps.md) +## 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 +- **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 +- **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 +- **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 +- **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. + +--- + +Take GarudaNvim for a spin, and you’ll see – it’s the Neovim setup you didn’t know you needed. It’s efficient, it’s powerful, and yes, it’s a bit sarcastic. But when you’re coding at warp speed, you’ll get it. diff --git a/docs/index.md b/docs/index.md index 4779eb4..54a2339 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,6 @@

- Welcome to GarudaNvim + Welcome to GarudaNvim

GarudaNvim Logo +

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: @@ -15,8 +17,10 @@ rm -f installGarudaNvim.sh
-### Uninstallation +## Uninstallation + To uninstall GarudaNvim, use the command below: + ```sh LATEST=$(curl -s https://api.github.com/repos/GarudaNvim/Installer/releases/latest | grep '"tag_name"' | cut -d '"' -f 4) wget -q https://raw.githubusercontent.com/GarudaNvim/Installer/$LATEST/uninstallGarudaNvim.sh diff --git a/docs/keymaps.md b/docs/keymaps.md index 056e180..3eee016 100644 --- a/docs/keymaps.md +++ b/docs/keymaps.md @@ -1,4 +1,6 @@ -# **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.* diff --git a/docs/plugins.md b/docs/plugins.md index 155c0cd..5d4f23c 100644 --- a/docs/plugins.md +++ b/docs/plugins.md @@ -1,4 +1,6 @@ -# **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. diff --git a/docs/themes.md b/docs/themes.md index 070581f..3199b9e 100644 --- a/docs/themes.md +++ b/docs/themes.md @@ -1,4 +1,6 @@ -# **Themes** +
+

Themes

+
GarudaNvim allows you to switch between themes and customize the look of your editor. @@ -13,9 +15,7 @@ Pick the one you like most. - Tokyonight - Tokyodark - Catppuccin -- Nyoom - Nightfox -- Doom-one ### Customizing Themes To customize the theme, modify the respective configuration file at: diff --git a/docs/whichkey.md b/docs/whichkey.md index 04b6ff4..859dbf7 100644 --- a/docs/whichkey.md +++ b/docs/whichkey.md @@ -1,4 +1,6 @@ -# **Keybindings in GarudaNvim** +
+

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.