Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arsham/arshamiser.nvim
Neovim status-bar based on feline, a colour scheme, and foldtext function
https://github.com/arsham/arshamiser.nvim
feline folding foldtext neovim neovim-colorscheme neovim-plugin statusbar statusline
Last synced: 16 days ago
JSON representation
Neovim status-bar based on feline, a colour scheme, and foldtext function
- Host: GitHub
- URL: https://github.com/arsham/arshamiser.nvim
- Owner: arsham
- License: mit
- Created: 2022-01-09T01:26:40.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-06-01T10:22:49.000Z (5 months ago)
- Last Synced: 2024-08-07T18:37:07.165Z (3 months ago)
- Topics: feline, folding, foldtext, neovim, neovim-colorscheme, neovim-plugin, statusbar, statusline
- Language: Lua
- Homepage:
- Size: 102 KB
- Stars: 35
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Arshamiser
Neovim status bar, colour scheme, foldtext and tabline functions. It has
support for `cmdheight=0` for macro recording message and visually selected
count.
1. [Demo](#demo)
2. [Requirements](#requirements)
3. [Installation](#installation)
- [Lazy](#lazy)
- [Packer](#packer)
- [Config](#config)
- [Lazy Loading](#lazy-loading)
4. [License](#license)
## Demo
## Palettes
## Requirements
This library supports [Neovim
v0.8.0](https://github.com/neovim/neovim/releases/tag/v0.8.0) and newer.
This plugin depends are the following libraries. Please make sure to add them
as dependencies in your package manager:
- [arshlib.nvim](https://github.com/arsham/arshlib.nvim)
- [feline.nvim](https://github.com/famiu/feline.nvim)
- [heirline.nvim](https://github.com/rebelot/heirline.nvim)
- [nvim-web-devicons](https://github.com/kyazdani42/nvim-web-devicons)
- [sqls.nvim](https://github.com/nanotee/sqls.nvim)
## Installation
Use your favourite package manager to install this library.
### Lazy
```lua
{
"arsham/arshamiser.nvim",
dependencies = {
"arsham/arshlib.nvim",
"famiu/feline.nvim",
"rebelot/heirline.nvim",
"kyazdani42/nvim-web-devicons",
"lewis6991/gitsigns.nvim",
},
config = function()
-- ignore any parts you don't want to use
vim.cmd.colorscheme("arshamiser_light")
require("arshamiser.feliniser")
-- or:
-- require("arshamiser.heirliniser")
_G.custom_foldtext = require("arshamiser.folding").foldtext
vim.opt.foldtext = "v:lua.custom_foldtext()"
-- if you want to draw a tabline:
vim.api.nvim_set_option("tabline", [[%{%v:lua.require("arshamiser.tabline").draw()%}]])
end,
}
```
### Packer
```lua
use({
"arsham/arshamiser.nvim",
requires = {
"arsham/arshlib.nvim",
"famiu/feline.nvim",
"rebelot/heirline.nvim",
"kyazdani42/nvim-web-devicons",
"lewis6991/gitsigns.nvim",
},
config = function()
-- ignore any parts you don't want to use
vim.cmd.colorscheme("arshamiser_light")
require("arshamiser.feliniser")
-- or:
-- require("arshamiser.heirliniser")
_G.custom_foldtext = require("arshamiser.folding").foldtext
vim.opt.foldtext = "v:lua.custom_foldtext()"
-- if you want to draw a tabline:
vim.api.nvim_set_option("tabline", [[%{%v:lua.require("arshamiser.tabline").draw()%}]])
end,
})
```
### Config
By default this pluging uses a palette for the colour scheme. You can use your
own palette if you want:
```lua
local colouriser = require("arshamiser.colouriser")
local palette = {} -- see the palette.lua for the values
colouriser.setup(palette, "my_awesome_scheme")
```
### Lazy Loading
You can defer setting the colorscheme until the UI loads. Packer example:
```lua
use({
"arsham/arshamiser.nvim",
requires = {
"arsham/arshlib.nvim",
"famiu/feline.nvim",
"rebelot/heirline.nvim",
"kyazdani42/nvim-web-devicons",
"nanotee/sqls.nvim",
"lewis6991/gitsigns.nvim",
},
config = function()
vim.api.nvim_create_autocmd("UIEnter", {
events = "UIEnter",
pattern = "*",
callback = function()
vim.cmd.colorscheme("arshamiser_light")
require("arshamiser.feliniser")
-- or:
-- require("arshamiser.heirliniser")
_G.custom_foldtext = require("arshamiser.folding").foldtext
vim.opt.foldtext = "v:lua.custom_foldtext()"
-- if you want to draw a tabline:
vim.api.nvim_set_option("tabline", [[%{%v:lua.require("arshamiser.tabline").draw()%}]])
end,
})
end,
event = { "UIEnter" },
})
```
## License
Licensed under the MIT License. Check the [LICENSE](./LICENSE) file for details.