From 4976c6db0e5a30befd0d6f4b5941491cec726fc0 Mon Sep 17 00:00:00 2001 From: prrockzed Date: Mon, 28 Oct 2024 19:36:53 +0530 Subject: [PATCH] Modified the themes page And made some other minor changes --- docs/assets/css/extra.css | 5 --- docs/index.md | 4 +- docs/installation.md | 3 ++ docs/keymaps.md | 4 +- docs/themes.md | 79 +++++++++++++++++++++++++++++++-------- 5 files changed, 71 insertions(+), 24 deletions(-) diff --git a/docs/assets/css/extra.css b/docs/assets/css/extra.css index b398118..2d75ff0 100644 --- a/docs/assets/css/extra.css +++ b/docs/assets/css/extra.css @@ -54,11 +54,6 @@ 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/index.md b/docs/index.md index f35268a..b92af33 100644 --- a/docs/index.md +++ b/docs/index.md @@ -83,6 +83,6 @@ Big thanks to [Neovim](https://github.com/neovim/neovim) for making terminal-bas ## Last Words... Happy Coding with GarudaNvim 💻
-Welcome to the Cult (oh sorry, I meant Club) +Welcome to the Cult (umm, I meant Club :P) -P.S. – This project is the brainchild of **Priyanshu Ranjan**, a final-year student at **IIT Kharagpur**, and he’s poured his heart (and far too many late-night and exam hours) into it. +P.S. – This project is the brainchild of **Priyanshu Ranjan**, a final-year student at **IIT Kharagpur**, and he’s poured his heart (and far too many late-night hours) into it. diff --git a/docs/installation.md b/docs/installation.md index bd8b80a..31c2f5f 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -27,3 +27,6 @@ wget -q https://raw.githubusercontent.com/GarudaNvim/Installer/$LATEST/uninstall chmod +x uninstallGarudaNvim.sh && { ./uninstallGarudaNvim.sh } || { echo } rm -f uninstallGarudaNvim.sh ``` +
+ +For more information on the script used for Installation (and Uninstallation), checkout our [Installer Repo](https://github.com/GarudaNvim/Installer) diff --git a/docs/keymaps.md b/docs/keymaps.md index f7642d6..3feb9f7 100644 --- a/docs/keymaps.md +++ b/docs/keymaps.md @@ -2,9 +2,9 @@

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.* +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.* +Also, don't forget that *this is just the beginning.* After mastering these, head over to the **[which-key](whichkey.md)** page—our beloved menu of shortcuts. Trust us, it’ll make you feel like a coding ninja, minus the actual ninja suit.* ## Neovim Modes - **Normal Mode** (`n`): The default mode for most actions, like navigating, editing, and breaking stuff (whoops). diff --git a/docs/themes.md b/docs/themes.md index 2dce5bd..f38958f 100644 --- a/docs/themes.md +++ b/docs/themes.md @@ -2,29 +2,78 @@

Themes

-GarudaNvim allows you to switch between themes and customize the look of your editor. +We know what a good colorscheme can do! It is soothing.
+It can make you happy if you are sad and happier if you are already happy :)
+GarudaNvim allows you to seamlessly switch themes and customize the look of your editor. -## Default Themes -- **Onedarkpro**: A sleek dark theme that enhances code visibility. +## Default Theme +**Onedarkpro**: A sleek dark theme that enhances code visibility. + +Note - Selected and configured by the author. Feel free to change it at `~/.config/nvim/lua/graudanvim/plugin_config/color_config/init.lua` ## Available Themes -Pick the one you like most. -- Dracula -- Nordic -- Tokyonight -- Tokyodark -- Catppuccin -- Nightfox +### Pre-Installed + +Neovim and Vim come with several built-in colorschemes. These are fairly minimal compared to custom themes but are reliable for basic color support. Here’s a list of the default colorschemes: + +- **default**: The standard colorscheme if no other is specified. +- **delek**: A bright and readable scheme, often with green and blue tones. +- **desert**: A dark, low-contrast scheme, easy on the eyes. +- **elflord**: A high-contrast theme with blue and green highlights. +- **evening**: A darker theme with blue-gray tones, great for low-light settings. +- **industry**: A blue and green scheme with high contrast. +- **koehler**: A high-contrast, sharp theme with bright yellow highlights. +- **morning**: A light theme with pastel colors. +- **murphy**: A classic dark theme with muted colors. +- **pablo**: A low-contrast, grayish theme, easier on the eyes. +- **peachpuff**: A light and pastel-colored theme. +- **ron**: A warm, dark scheme with brown and green highlights. +- **shine**: A theme with light colors, good for readability. +- **slate**: A soft, dark theme with a slight blue tint. +- **torte**: A mostly light-colored theme with subtle highlights. + +### Externally Added + +Beyond the built-in options, GarudaNvim brings additional color-rich themes that enhance the visual experience. Here’s a selection of popular externally added themes: + +- **OneDarkPro**: Vibrant, professional, and easy on the eyes. +- **Dracula**: Dark with purple-pink highlights, gentle on eyes. +- **Nordic**: Cool blues and grays, minimalist vibe. +- **Tokyonight**: Inspired by Tokyo’s nightlife, moody and dark. +- **Tokyodark**: Deep blacks and blues, high contrast. +- **Catppuccin**: Warm pastels, cozy and relaxing. +- **Nightfox**: Dark themes with harmonious color accents. + +## Switching Themes + +Ah, the joy of theme-switching – like picking out a new outfit for your code! For the best experience, we highly recommend using the custom keymap that makes it effortless to try out different themes and get a live preview, all with a few taps. + +### GarudaNvim Way +To switch themes instantly, just hit: +``` + + z + t +``` +Your `which-key` setup has this mapped beautifully, so go ahead and tap away to preview themes on the fly! Why use this? Because it’s more satisfying than typing commands like it’s the 90s. Plus, who doesn’t love a shortcut? + +
OR
+ +### The Traditional Way +Still a fan of the classics? You can switch themes the old-school way with this command: + +```vim +:colorscheme +``` + +Simply replace `` with the name of your desired theme, like `:colorscheme desert`. + +**Pro Tip**: Remember, a good theme isn’t just for looks – it’s a vibe. Choose what suits you best! ## Customizing Themes -To customize the theme, modify the respective configuration file at: + +To tweak an existing theme, modify the respective configuration file at: ``` ~/.config/nvim/lua/garudanvim/plugin_config/color_config/ ``` -
In this file, you can change colors, contrasts, and more to match your preference. - -For a more personalized setup, you can also add your own themes or tweak existing ones using Neovim's built-in theme options. -