Skip to content

A generic and modular lua sidebar for Neovim

Notifications You must be signed in to change notification settings

CrackerCat/sidebar.nvim

 
 

Repository files navigation

sidebar.nvim

A generic and modular lua sidebar inspired by lualine

Development status: Alpha - bugs are expected

screenshot

Quick start

local sidebar = require("sidebar-nvim")
local opts = {open = true}
sidebar.setup(opts)

See options for a full list of setup options

Requirements

  • Neovim 0.6
  • Nerdfonts (requirement by the default icons, you can change the icons to remove this requirement)

Quick links

TODOs (Need help)

  • Better section icons - users can define custom icons see Options
  • Allow sections to define custom hl groups for icons
  • Improve docs + write vim help files
  • See repo issues, any contribution is really appreciated

Third party sections

Development

We are trying to limit the frequency of merges to the default branch, therefore less noise during plugin update and possible less bugs.

If you don't mind frequent updates and/or want to test new features, you might want to check the dev branch.

Before reporting a bug, please check if the bug still exists in the dev branch.

References

We based most of the code from the awesome work of @kyazdani42 in nvim-tree

Contributors

@GustavoKatel @davysson

About

A generic and modular lua sidebar for Neovim

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Lua 98.9%
  • Vim Script 1.1%