https://github.com/maxmx03/terminal.nvim
https://github.com/maxmx03/terminal.nvim
neovim nvim-plugin plugin terminal
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/maxmx03/terminal.nvim
- Owner: maxmx03
- License: gpl-3.0
- Created: 2024-10-22T23:02:07.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-06T22:56:53.000Z (7 months ago)
- Last Synced: 2025-08-30T03:34:11.885Z (4 months ago)
- Topics: neovim, nvim-plugin, plugin, terminal
- Language: Lua
- Homepage:
- Size: 26.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Terminal
## Installation
```lua
{
'maxmx03/terminal.nvim',
opts = {
layout = 'float' -- below
size = 0.7 -- value between 0 and 1, 0.7 == 70%
},
}
```
```vim
Plug 'maxmx03/terminal.nvim'
lua << EOF
local terminal = require('terminal')
terminal.setup({
layout = 'float',
size = 0.7
})
EOF
```
## Commands and Keymaps
```lua
-- Open terminal in normal mode with F3
map("n", "", "TermOpen", { silent = true })
-- Close terminal in terminal mode with F3
map("t", "", "TermClose", { silent = true })
-- Hide terminal in terminal mode with F3
map("t", "", "TermHide", { silent = true })
-- Open terminal and run a specific command (e.g., `make`) with F4
map("n", "", "TermOpen make", { silent = true })
```
## Looking for Advanced Configuration Examples?
Check out the [Wiki](https://github.com/maxmx03/terminal.nvim/wiki)