README.md

sidebar.nvim

A generic and modular lua sidebar inspired by lualine

Development status: Alpha - bugs are expected

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

• Options, commands, api and colors
• Builtin sections
• Custom sections

TODOs (Need help)

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

Third party sections

• dap-sidebar.nvim - Show Dap breakpoints in the sidebar

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