Skip to content

Commit

Permalink
Merge pull request #72 from StrangeRanger/dev
Browse files Browse the repository at this point in the history
Modify the wording 'Modifying CLI Colors' and 'Text Editor'  sections (one last review to be made)
  • Loading branch information
StrangeRanger authored Nov 25, 2024
2 parents 5b5ce06 + a4faf37 commit d9592d2
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 26 deletions.
36 changes: 16 additions & 20 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,8 +110,6 @@ Below are aliases I've create, organized into two groups: Group 1 and Group 2. G

### Modifying CLI Colors

<!-- TODO: Potentially re-word this section. -->

You can customize the colors of folders, files, and other items in the terminal by setting the `LS_COLORS` or `LSCOLORS` environment variables.(1) Each variable uses a unique format to specify the colors and styles of different file types and directories. For more information regarding these variables, refer to the "CLI Colors Explained" drop-down.
{ .annotate }

Expand Down Expand Up @@ -153,11 +151,9 @@ You can further modify the shading and appearance of CLI colors by adjusting the

## Text Editor

<!-- TODO: Potentially re-word this section. -->

There are many terminal-based text editors to choose from, each with unique features and capabilities. I've found that [Neovim](https://github.com/neovim/neovim) is the most powerful and versatile option for my needs.

Neovim a fork of [Vim](https://github.com/vim/vim) that aims to improve upon Vim's features and performance, with a focus on extensibility and usability. It is designed to be more user-friendly and accessible to new users while still providing the power and flexibility that experienced users expect.
<!-- Neovim a fork of [Vim](https://github.com/vim/vim) that aims to improve upon Vim's features and performance, with a focus on extensibility and usability. It is designed to be more user-friendly and accessible to new users while still providing the power and flexibility that experienced users expect. -->

### Neovim Resource File

Expand Down Expand Up @@ -186,21 +182,23 @@ Neovim leverages [TreeSitter](https://github.com/tree-sitter/tree-sitter) to pro
- **Enhanced Syntax Highlighting**: With custom configurations, it delivers consistent and accurate syntax highlighting tailored to each language.
- **Advanced Code Features**: Besides highlighting, it enables and enhances features like structural code navigation, incremental selection, code folding, and extensions like rainbow parentheses.

Below are my configurations for `nvim-treesitter` in Neovim. Currently, they ensure that the specified parsers are automatically installed and loaded. To use these settings, add the following code to `~/.config/nvim/second_init.lua` (1):
Below are my configurations for `nvim-treesitter`. Currently, they ensure that the specified parsers are automatically installed and loaded. To use these settings, add the following code to `~/.config/nvim/second_init.lua` (1):
{ .annotate }

1. `nvim-treesitter` requires Lua to function. As a result, the configurations are written in Lua and stored in a separate file, `second_init.lua`. My `init.vim` file, as displayed [above](#__tabbed_5_1), sources this Lua file to enable the necessary settings.
1. `nvim-treesitter` requires Lua to function. As a result, the configurations are written in Lua and stored in a separate file, `second_init.lua`. My `init.vim` file, as displayed [above](#__tabbed_5_1), sources this Lua file to enable the `nvim-treesitter` settings.

```lua title="second_init.lua"
--8<-- "includes/neovim-init-files/neovim-init-lua.lua"
```

If you're **NOT** using the `init.vim` file that I provided [above](#__tabbed_5_1), and your `init` file is written in vimscript, you'll want to add the following code to your `init.vim` file:
If you're **NOT** using the `init.vim` file I provided, you'll want to add the following code to your version of the file:

```vim title="init.vim"
lua dofile(vim.fn.stdpath('config') .. '/second_init.lua')
```

This will ensure the `nvim-treesitter` configurations are loaded correctly.

///

/// tab | Without Plugins
Expand All @@ -215,15 +213,13 @@ These configurations are designed for users who prefer a more straightforward se

## Terminal Profile

<!-- TODO: Potentially re-word this section. -->

A terminal profile is the collective configurations that result in the visual appearance of the terminal window, including the color scheme, font style, and other visual elements. Customizing the terminal profile can enhance the overall user experience and make working in the terminal more enjoyable.
A terminal profile is a set of configurations that define the visual appearance and behavior of the terminal window, including the color scheme, font style, and other visual elements. Customizing the terminal profile can improve the user experience, making the terminal more visually appealing and easier to work with.

/// tab | macOS

My custom terminal profile is a modified version of the Basic profile that comes pre-installed on macOS. To add it to your list of profiles, follow these steps:
My custom profile is a modified version of the "Basic" profile that comes pre-installed on macOS. To add it to your list of profiles, follow the instructions below:

1. Download the terminal profile: [Basic (Modified).terminal](Terminal%20Profiles/Basic%20%28Modified%29.terminal).
1. Download the terminal profile: [Basic (Modified).terminal](terminal-profiles/Basic%20(Modified).terminal)
2. Open a new terminal window.
3. Import the profile:
1. Go to **Preferences**.
Expand All @@ -239,16 +235,16 @@ My custom terminal profile is a modified version of the Basic profile that comes

/// tab | Linux

My custom terminal profile is a based on the one I use on macOS. To add it to your list of profiles, follow the instructions below:
My custom profile is based on the one I use for macOS. To add it to your list of profiles, follow the instructions below:

1. Download the terminal profile: [Gnome Basic (Modified).dconf](Terminal%20Profiles/Gnome%20Basic%20%28Modified%29.dconf).
2. Download the profile setup script: [gnome-terminal-profile-setup.bash](Terminal%20Profiles/gnome-terminal-profile-setup.bash)
1. Download the terminal profile: [Gnome Basic (Modified).dconf](terminal-profiles/gnome-terminal-profile.dconf)
2. Download the profile setup script: [terminal-profile-setup.bash](terminal-profiles/terminal-profile-setup.bash)
3. Open a new terminal window.
4. Navigate to the directory where you downloaded both files.
5. Execute the code:
4. Navigate to the directory where both files were downloaded to (e.g., `~/Downloads`).
5. Execute the following code:
```bash
chmod +x gnome-terminal-profile-setup.bash
./gnome-terminal-profile-setup.bash
chmod +x terminal-profile-setup.bash
./terminal-profile-setup.bash
```

///
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ highlight-foreground-color='rgb(255,255,255)'
palette=['rgb(0,0,0)', 'rgb(153,0,0)', 'rgb(77,156,68)', 'rgb(176,176,1)', 'rgb(0,93,255)', 'rgb(178,0,178)', 'rgb(0,166,178)', 'rgb(142,142,142)', 'rgb(102,102,102)', 'rgb(229,0,0)', 'rgb(0,217,0)', 'rgb(228,227,2)', 'rgb(0,143,255)', 'rgb(229,0,229)', 'rgb(0,229,229)', 'rgb(229,229,229)']
use-system-font=false
use-theme-colors=false
visible-name='Basic (Modified)'
visible-name='Custom Profile'
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
#
# Automates the process of setting a custom Gnome Terminal profile as the default.
#
# Version: v1.0.0
# Version: v1.0.1
# License: MIT License
# Copyright (c) 2024 Hunter T. (StrangeRanger)
#
########################################################################################
####[ Global Variables ]################################################################


readonly C_PROFILE_FILE_NAME="Gnome Basic (Modified).dconf"
readonly C_PROFILE_FILE_NAME="gnome-terminal-profile.dconf"
readonly C_DCONF_PATH="/org/gnome/terminal/legacy/profiles:/"

# This allows for a more dynamic way to get the UUID of the profile.
Expand All @@ -21,17 +21,15 @@ readonly C_UUID
C_YELLOW="$(printf '\033[1;33m')"
C_GREEN="$(printf '\033[0;32m')"
C_BLUE="$(printf '\033[0;34m')"
C_CYAN="$(printf '\033[0;36m')"
C_RED="$(printf '\033[1;31m')"
C_NC="$(printf '\033[0m')"
readonly C_YELLOW C_GREEN C_BLUE C_CYAN C_RED C_NC
readonly C_YELLOW C_GREEN C_BLUE C_RED C_NC

## Shorthanded variables for colorized output.
readonly C_WARNING="${C_YELLOW}==>${C_NC} "
readonly C_SUCCESS="${C_GREEN}==>${C_NC} "
readonly C_ERROR="${C_RED}ERROR:${C_NC} "
readonly C_INFO="${C_BLUE}==>${C_NC} "
readonly C_NOTE="${C_CYAN}==>${C_NC} "


####[ Functions ]#######################################################################
Expand Down

0 comments on commit d9592d2

Please sign in to comment.