INSTALL INSTRUCTIONS

title

description

author

INSTALL INSTRUCTIONS

All of my main config is contained in this file config.norg, to be able to use this config you have to first tangle the file to generate the config.lua file.

Create lua directory. A lua directory is needed so that the config.lua file can be crated inside of it. Run the below command inside of your shell at the root of this config:

mkdir lua

Open Neovim to bootstrap the config. A. Because the Lazy.nvim package manager and Neorg plugin is required to tangle the config, you have to bootstrap the config for the first time. Don't worry this happens automatically, you just have to open Neovim by running:

nvim

You will see some errors pop up, don't worry about them this just happens because Neovim expects there to be a config which is not there yet.

B. After this is done, close Neovim again by running the below command:

:qa

Tangle the config.norg file. A. Last, we need to tangle the config.norg file, to do so open the file with Neovim by running the following command:

nvim config.norg

B. After the config.norg file is opened in Neovim, run the following command inside Neovim:

:Neorg tangle

Neovim will ask you which file to tangle, select config.norg

Reopen Neovim and enjoy Close and reopen Neovim and the Lazy plugin manager will install everything needed. You might have to reopen Neovim a few times to make sure everything is installed.

SETUP VARIABLES AND FUNCTIONS

Leader keys

Used by many plugins for keybindings, need to be set early as plugins can be dependant on it.

vim.g.mapleader = ' '
vim.g.maplocalleader = '  '

API Variables

Declare common API variables, will be used throughout the config.

| Variable | Value | Descriptions | |----------+---------+------------------------| | o | vim.opt | Inbuilt vim options | | g | vim.g | Inbuilt global options | | cmd | vim.cmd | Run vim ex commands |

local o = vim.opt
local g = vim.g
local cmd = vim.cmd

Global Print Table Function

The P() function can be used globally to print a lua table for inspection.

P = function(v)
  print(vim.inspect(v))
  return v
end

Lazy Helper Function

The plug() function is used to add plugins to the plugins table. The plugins table will be used by lazy to install and load plugins.

local plugins = {}

function plug(plugin)
  plugins[#plugins +1] = plugin
end

OPTIONS

Configure inbuilt Neovim options.

o.autowrite = true           -- Enable auto write
o.clipboard = "unnamedplus"  -- Sync with system clipboard
o.completeopt = "menu,menuone,noselect" -- Completion options for better experience
o.conceallevel = 3           -- Hide * markup for bold and italic
o.confirm = true             -- Confirm to save changes before exiting modified buffer
o.cursorline = true          -- Enable highlighting of the current line
o.breakindent = true         -- Every wrapped line will honor indent
o.expandtab = true           -- Use spaces instead of tabs
o.formatoptions = "jcroqlnt" -- Format options for automatic formatting
o.grepformat = "%f:%l:%c:%m" -- Format for grep output
o.grepprg = "rg --vimgrep"   -- Use ripgrep for grep command
o.ignorecase = true          -- Ignore case in search patterns
o.inccommand = "nosplit"     -- Preview incremental substitute
o.laststatus = 0             -- Never show status line
o.list = true                -- Show some invisible characters (tabs, trailing spaces)
o.mouse = "a"                -- Enable mouse mode
o.number = true              -- Print line number
o.pumblend = 10              -- Popup blend transparency
o.pumheight = 10             -- Maximum number of entries in a popup
o.relativenumber = true      -- Relative line numbers
o.scrolloff = 4              -- Lines of context around cursor
o.sessionoptions = { "buffers", "curdir", "tabpages", "winsize" } -- Session save options
o.shiftround = true          -- Round indent to multiple of shiftwidth
o.shiftwidth = 2             -- Size of an indent
o.shortmess:append({ W = true, I = true, c = true }) -- Reduce message verbosity
o.showmode = false           -- Don't show mode since we have a statusline
o.sidescrolloff = 8          -- Columns of context around cursor
o.signcolumn = "yes"         -- Always show the signcolumn, otherwise it would shift the text each time
o.smartcase = true           -- Don't ignore case with capitals
o.smartindent = true         -- Insert indents automatically
o.spelllang = { "en" }       -- Spell checking language
o.splitbelow = true          -- Put new windows below current
o.splitright = true          -- Put new windows right of current
o.tabstop = 2                -- Number of spaces tabs count for
o.termguicolors = true       -- True color support
o.timeoutlen = 300           -- Time to wait for a mapped sequence to complete
o.undofile = true            -- Save undo history to file
o.undolevels = 10000         -- Maximum number of changes that can be undone
o.updatetime = 200           -- Save swap file and trigger CursorHold
o.wildmode = "longest:full,full" -- Command-line completion mode
o.winminwidth = 5            -- Minimum window width
o.wrap = false               -- Disable line wrap
o.foldlevelstart = 0         -- Enable foldlevel when opening file
o.foldnestmax = 2            -- Set max nested foldlevel
vim.opt.foldenable = true    -- Enable folding
vim.opt.foldmethod = "expr"  -- Use expression for folding
vim.opt.foldexpr = "v:lua.vim.treesitter.foldexpr()" -- Use treesitter for fold expression
vim.o.foldtext = ''          -- Use default fold text
vim.o.fillchars = 'fold: '   -- Characters to fill folds

if vim.fn.has("nvim-0.9.0") == 1 then
  o.splitkeep = "screen"
  o.shortmess:append({ C = true })
end

-- use powershell on windows
if vim.fn.has("win32") == 1 then
  o.shell = vim.fn.executable "pwsh" == 1 and "pwsh" or "powershell"
  o.shellcmdflag =
  "-NoLogo -NoProfile -ExecutionPolicy RemoteSigned -Command [Console]::InputEncoding=[Console]::OutputEncoding=[System.Text.Encoding]::UTF8;"
  o.shellredir = "-RedirectStandardOutput %s -NoNewWindow -Wait"
  o.shellpipe = "2>&1 | Out-File -Encoding UTF8 %s; exit LastExitCode"
  o.shellquote = ""
  o.shellxquote = ""
end

-- if in a wsl environment WSL_DISTRO_NAME should be set
local in_wsl = os.getenv('WSL_DISTRO_NAME') ~= nil

if in_wsl then
  -- Need to install win32yank in windows
  -- see https://mitchellt.com/2022/05/15/WSL-Neovim-Lua-and-the-Windows-Clipboard.html
  vim.g.clipboard = {
    name = "win32yank-wsl",
    copy = {
      ["+"] = "win32yank.exe -i --crlf",
      ["*"] = "win32yank.exe -i --crlf",
    },
    paste = {
      ["+"] = "win32yank.exe -o --lf",
      ["*"] = "win32yank.exe -o --lf",
    },
    cache_enabled = true,
  }
end

SYNTAX HIGHLIGHTS & COLOR

Here I set up the color and syntax used in Neovim buffers.

Options

Enable true color support:

o.termguicolors = true

Gruvebox Colorscheme

A retro groove color scheme with warm, earthy tones designed for comfortable long coding sessions. Gruvbox provides excellent contrast and readability while being easy on the eyes.

This colorscheme implementation offers:

Warm color palette: Carefully selected browns, oranges, and muted colors that reduce eye strain
Treesitter integration: Full support for modern syntax highlighting with semantic tokens
Transparency support: Optional transparent background for terminal integration
Comprehensive language support: Optimized colors for all major programming languages
Dark and light variants: Multiple contrast levels to suit different lighting conditions
Accessibility focused: High contrast ratios and colorblind-friendly palette choices

Usage: The colorscheme is automatically applied on startup. The configuration includes transparency mode and custom overrides for better markdown and code block visibility.

Help: The theme provides consistent highlighting across all file types while maintaining the distinctive Gruvbox aesthetic that has made it popular among developers worldwide.

For example, comments appear in a muted gray-brown, strings in warm green, and keywords in bright orange, creating a cohesive and pleasant coding environment.

Name		Name	Last commit message	Last commit date
Latest commit History 270 Commits
.gitignore		.gitignore
LICENSE.md		LICENSE.md
README.md		README.md
config.norg		config.norg
init.lua		init.lua

License

simonhughxyz/NeovimConfig

Folders and files

Latest commit

History

Repository files navigation

INSTALL INSTRUCTIONS

SETUP VARIABLES AND FUNCTIONS

Leader keys

API Variables

Global Print Table Function

Lazy Helper Function

OPTIONS

SYNTAX HIGHLIGHTS & COLOR

Options

Gruvebox Colorscheme

Colorizer

Rainbow

Sentiment

Headlines

UI

Lualine

NEORG

SNACKS

VIM-ILLUMINATE

FILE NAVIGATION

Oil

Neo-Tree

Project.nvim

BUFFER NAVIGATION

EYELINER

Nvim Spider

GIT

Fugitive

Gitsigns

Diffview

LSP

DEBUG

TEXT MANIPULATION

Comment.nvim

Dial.nvim

Nvim-Surround

Nvim-various-textobjs

Treesj

Text case

Autolist

TERMINAL

Toggle Term

Flatten

VIM TABLE MODE

TODO COMMENTS

MARKS

MARKDOWN

Nvim Toc

Glow

Requirements

Preview

Hl-MDCodeblock

TROUBLE

WHICH KEY

HLSLENS

YANKY

MINI SESSIONS

TREESITTER

Treesitter

Endwise

Virtual Text Context

Mini Ai

LAZY

KEYMAPS

HIGHLIGHTS

AUTOCOMMANDS

EXCOMMANDS

SHM

UTILS

SNIPPETS

Luasnip API Variables

Utils

Snippets

All

Packages