Home

Awesome

<h1 align="center"> šŸŒˆ NeoColumn.nvim </h1> <p align="center"> <a href="http://www.lua.org"> <img alt="Lua" src="https://img.shields.io/badge/Lua-blue.svg?style=for-the-badge&logo=lua" /> </a> <a href="https://neovim.io/"> <img alt="Neovim" src="https://img.shields.io/badge/NeoVim-%2357A143.svg?&style=for-the-badge&logo=neovim&logoColor=white" /> </a> </p>

demo

šŸ“¢ Introduction

NeoColumn is a Neovim plugin that shows a focused ColorColumn at a specific position to manage line length. It highlights individual characters, minimizing clutter and enhancing readability

āœØ Features

šŸ’¾ Persistence

NeoColumn maintains the ColorColumn settings for each file, including visibility and position, across sessions.

šŸ› ļø Usage

To toggle NeoColumn on/off, you can use the ToggleNeoColumn command:

:ToggleNeoColumn

You can also create a keybinding to toggle NeoColumn more conveniently:

vim.keymap.set("n", "<leader>h", "<cmd>ToggleNeoColumn<cr>", { noremap = true, silent = true })

To clear the list of enabled/disabled files in NeoColumn, you can use the ClearNeoColumn command:

:ClearNeoColumn

šŸ“¦ Installation

  1. Install via your favorite package manager.
{
  "ecthelionvi/NeoColumn.nvim",
  opts = {}
},
use "ecthelionvi/NeoColumn.nvim"
  1. Setup the plugin in your init.lua. Skip this step if you're fine with the default settings or using lazy.nvim with opts set as above.
require("NeoColumn").setup()

šŸ”§ Configuration

You can pass your config table into the setup() function or opts if you use lazy.nvim.

The available options:

Default Config

local config = {
  fg_color = "",
  bg_color = "",
  NeoColumn = "80",
  always_on = false,
  custom_NeoColumn = {},
  excluded_ft = { "text", "markdown" },
}