https://github.com/0xstepit/flow.nvim
A flow-immersive Nvim colorscheme with fluorescent details.
https://github.com/0xstepit/flow.nvim
coding colorscheme fluo lua nvim productivity via
Last synced: 4 months ago
JSON representation
A flow-immersive Nvim colorscheme with fluorescent details.
- Host: GitHub
- URL: https://github.com/0xstepit/flow.nvim
- Owner: 0xstepit
- License: apache-2.0
- Created: 2024-06-25T19:56:55.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-29T19:04:41.000Z (9 months ago)
- Last Synced: 2024-10-29T21:16:41.431Z (9 months ago)
- Topics: coding, colorscheme, fluo, lua, nvim, productivity, via
- Language: Lua
- Homepage:
- Size: 34.5 MB
- Stars: 178
- Watchers: 1
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-neovim - 0xstepit/flow.nvim - Carefully designed colors to help focusing during coding plus fluorescent details. Support many plugins and tools. (Colorscheme / Tree-sitter Supported Colorscheme)
- awesome-neovim-sorted - 0xstepit/flow.nvim - immersive Nvim colorscheme with fluorescent details. | (Colorscheme)
- awesome-neovim-sorted - 0xstepit/flow.nvim - immersive Nvim colorscheme with fluorescent details. | (Colorscheme)
README
# 🌊 Flow
Flow is an [Nvim](https://github.com/neovim/neovim) color scheme written in
[Lua](https://www.lua.org/). It features a carefully curated palette to enhance
focus during coding, complemented by fluorescent accents for a vibrant and dynamic look.
Why fluo? Because it's simply cool!
## Showcase
## Palette
Flow uses a palette of nine HSL-based colors, chosen to create a cohesive and visually appealing
environment. The primary color is light blue, with supporting tones selected as follows based on
the saturation value:
- **Analogous** (±30°): blue, cyan.
- **Complementary** (±180°): orange.
- **Tetradic** 60 (±60°): purple, green.
- **Split comp** (±150°): yellow, red.
Additionally, sky blue enhances the blue tones, and a fluorescent color provides striking accents.
## Requirements
- [Neovim](https://github.com/neovim/neovim) >=
[0.8.0](https://github.com/neovim/neovim/releases/tag/v0.8.0)
## Installation
Install Flow with your preferred package manager, such as
[folke/lazy.nvim](https://github.com/folke/lazy.nvim):
```lua
{
"0xstepit/flow.nvim",
lazy = false,
priority = 1000,
tag = "vX.0.0",
opts = {
-- Your configuration options here.
},
}
```
> Use the tag field to prevent breaking changes from automatic updates.
## Usage
### Lua
Setup and start using Flow with default options:
```lua
require("flow").setup{}
vim.cmd "colorscheme flow"
```
## Configuration
The following section describes how to configure the plugin using Lazy plugin manager.
### Default
```lua
return {
"0xstepit/flow.nvim",
lazy = false,
priority = 1000,
tag = "v2.0.1",
opts = {
theme = {
style = "dark", -- "dark" | "light"
contrast = "default", -- "default" | "high"
transparent = false, -- true | false
},
colors = {
mode = "default", -- "default" | "dark" | "light"
fluo = "pink", -- "pink" | "cyan" | "yellow" | "orange" | "green"
custom = {
saturation = "", -- "" | string representing an integer between 0 and 100
light = "", -- "" | string representing an integer between 0 and 100
},
},
ui = {
borders = "inverse", -- "theme" | "inverse" | "fluo" | "none"
aggressive_spell = false, -- true | false
},
},
config = function(_, opts)
require("flow").setup(opts)
vim.cmd("colorscheme flow")
end,
},
}
```
Keep in mind that the `transparent` flag sets the background of neovim transparent and, as a
result, the terminal emulator background will be visible. It is suggested to always add some bluur
to the terminal emulator when the background is transparent.
## Supported plugins
Below the list of supported plugins divided by category:
- **Git**: [fugitive](https://github.com/tpope/vim-fugitive), [gitsign](https://github.com/lewis6991/gitsigns.nvim).
- **Completion**: [nvim-cmp](https://github.com/hrsh7th/nvim-cmp), [lsp-kind](https://github.com/onsails/lspkind.nvim).
- **Debug**: [nvim-dap](https://github.com/mfussenegger/nvim-dap).
- **Coding**: [telescope](https://github.com/nvim-telescope/telescope.nvim),
[treesitter](https://github.com/nvim-treesitter/nvim-treesitter),
[ibl](https://github.com/lukas-reineke/indent-blankline.nvim),
[oil](https://github.com/stevearc/oil.nvim),
[flash](https://github.com/folke/flash.nvim)
- **AI**: [avante](https://github.com/yetone/avante.nvim)
- **Utils**: [lazy](https://github.com/folke/lazy.nvim),
[mason](https://github.com/williamboman/mason.nvim)
[trouble](https://github.com/folke/trouble.nvim),
[todo-comments](https://github.com/folke/todo-comments.nvim),
[which-key](https://github.com/folke/which-key.nvim),
[render-markdwon](https://github.com/MeanderingProgrammer/render-markdown.nvim),
[mini-hipatterns](https://github.com/echasnovski/mini.hipatterns)
- **Base Nvim**: diagnostic, lsp, markdown.
## Extras
Flow.nvim provides colorschemes also for the following tools:
- [Tmux](https://github.com/tmux/tmux/wiki) at [tmux-flow.conf](./extra/eclipse/tmux-flow-pink.conf).
- [Alacritty](https://alacritty.org/) at [alacritty-flow.toml](./extra/eclipse/alacritty-flow-pink.toml).
- [Kitty](https://sw.kovidgoyal.net/kitty/) at [kitty-flow.conf](./extra/eclipse/kitty-flow-pink.conf).
- [fzf](https://github.com/junegunn/fzf) at [fzf-flow.sh](./extra/eclipse/fzf-flow-pink.sh).
- [ghostty](https://github.com/ghostty-org/ghostty) at [ghostty-flow.config](./extra/eclipse/ghostty-flow-pink.config).
To generate extra themes you can use the `Makefile`:
```sh
make extras
```
Now you can copy generated files at `./extras/` where your configuration is sourcing them.
## Contributing
Pull requests and improvement suggestions are very welcome! If you want to help
developing the plugin, please consider addressing one of the issue marked as
[`good-first-issue`](https://github.com/0xstepit/flow.nvim/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22).
Or create a PR with improvements you would like to see!
## Contributors
## References
My dotfile: [0xstepit/dotfiles](https://github.com/0xstepit/dotfiles).
This project is inspired by other amazing colorscheme:
- [Tokyo Night](https://github.com/folke/tokyonight.nvim)
- [Gruvbox](https://github.com/morhetz/gruvbox)
- [Nordic](https://github.com/AlexvZyl/nordic.nvim)