@@ -10,7 +10,7 @@ A **work-in-progress** [Magit](https://magit.vc) clone for [Neovim](https://neov
1010require ` nvim-lua/plenary.nvim ` using your plugin manager of choice, before requiring this plugin.
1111
1212| Plugin Manager | Command |
13- | ------------------------------------------------------ | -------------------------------------------------------------------------------- |
13+ | ---------------------------------------------------- | ------------------------------------------------------------------------------ |
1414| [ Packer] ( https://github.com/wbthomason/packer.nvim ) | ` use { 'TimUntersberger/neogit', requires = 'nvim-lua/plenary.nvim' } ` |
1515| [ Vim-plug] ( https://github.com/junegunn/vim-plug ) | ` Plug 'TimUntersberger/neogit' ` |
1616| [ NeoBundle] ( https://github.com/Shougo/neobundle.vim ) | ` NeoBundle 'TimUntersberger/neogit' ` |
@@ -20,6 +20,7 @@ require `nvim-lua/plenary.nvim` using your plugin manager of choice, before requ
2020| [ Dep] ( https://github.com/chiyadev/dep ) | ` {'TimUntersberger/neogit', requires = {'nvim-lua/plenary.nvim'}} ` |
2121
2222You also use in the built-in package manager:
23+
2324``` bash
2425$ git clone --depth 1 https://github.com/TimUntersberger/neogit $XDG_CONFIG_HOME /nvim/pack/plugins/start/neogit
2526```
@@ -63,43 +64,44 @@ neogit.open({ cwd = "~" })
6364
6465The create function takes 1 optional argument that can be one of the following values:
6566
66- * tab (default)
67- * replace
68- * floating (This currently doesn't work with popups. Very unstable)
69- * split
70- * split_above
71- * vsplit
67+ - tab (default)
68+ - replace
69+ - floating (This currently doesn't work with popups. Very unstable)
70+ - split
71+ - split_above
72+ - vsplit
7273
7374## Status Keybindings
7475
75- | Keybinding | Function |
76- | --------------| --------------------------------------------------|
77- | Tab | Toggle diff |
78- | 1, 2, 3, 4 | Set a foldlevel |
79- | $ | Command history |
80- | b | Branch popup |
81- | s | Stage (also supports staging selection/hunk) |
82- | S | Stage unstaged changes |
83- | \< C-s> | Stage Everything |
84- | u | Unstage (also supports staging selection/hunk) |
85- | U | Unstage staged changes |
86- | c | Open commit popup |
87- | r | Open rebase popup |
88- | L | Open log popup |
89- | p | Open pull popup |
90- | P | Open push popup |
91- | Z | Open stash popup |
92- | ? | Open help popup |
93- | x | Discard changes (also supports discarding hunks) |
94- | \< enter> | Go to file |
95- | \< C-r> | Refresh Buffer |
76+ | Keybinding | Function |
77+ | ---------- | ------------------------------------------------ |
78+ | Tab | Toggle diff |
79+ | 1, 2, 3, 4 | Set a foldlevel |
80+ | $ | Command history |
81+ | b | Branch popup |
82+ | s | Stage (also supports staging selection/hunk) |
83+ | S | Stage unstaged changes |
84+ | \< C-s> | Stage Everything |
85+ | u | Unstage (also supports staging selection/hunk) |
86+ | U | Unstage staged changes |
87+ | c | Open commit popup |
88+ | r | Open rebase popup |
89+ | m | Open merge popup |
90+ | L | Open log popup |
91+ | p | Open pull popup |
92+ | P | Open push popup |
93+ | Z | Open stash popup |
94+ | ? | Open help popup |
95+ | x | Discard changes (also supports discarding hunks) |
96+ | \< enter> | Go to file |
97+ | \< C-r> | Refresh Buffer |
9698
9799With ` diffview ` integration enabled
98100
99- | Keybinding | Function |
100- | -------------- | -------------------------------------------------- |
101- | d | Open ` diffview.nvim ` at hovered file |
102- | D (TODO) | Open diff popup |
101+ | Keybinding | Function |
102+ | ---------- | ------------------------------------ |
103+ | d | Open ` diffview.nvim ` at hovered file |
104+ | D (TODO) | Open diff popup |
103105
104106## Configuration
105107
@@ -211,29 +213,29 @@ Right now, only the status buffer supports custom mappings.
211213
212214List of status commands:
213215
214- * Close
215- * Depth1 (Set foldlevel to 1)
216- * Depth2 (Set foldlevel to 2)
217- * Depth3 (Set foldlevel to 3)
218- * Depth4 (Set foldlevel to 4)
219- * Toggle
220- * Discard (Normal and visual mode)
221- * Stage (Normal and visual mode)
222- * StageUnstaged
223- * StageAll
224- * GoToFile
225- * Unstage (Normal and visual mode)
226- * UnstageStaged
227- * CommandHistory
228- * RefreshBuffer
229- * HelpPopup
230- * PullPopup
231- * PushPopup
232- * FetchPopup
233- * CommitPopup
234- * LogPopup
235- * StashPopup
236- * BranchPopup
216+ - Close
217+ - Depth1 (Set foldlevel to 1)
218+ - Depth2 (Set foldlevel to 2)
219+ - Depth3 (Set foldlevel to 3)
220+ - Depth4 (Set foldlevel to 4)
221+ - Toggle
222+ - Discard (Normal and visual mode)
223+ - Stage (Normal and visual mode)
224+ - StageUnstaged
225+ - StageAll
226+ - GoToFile
227+ - Unstage (Normal and visual mode)
228+ - UnstageStaged
229+ - CommandHistory
230+ - RefreshBuffer
231+ - HelpPopup
232+ - PullPopup
233+ - PushPopup
234+ - FetchPopup
235+ - CommitPopup
236+ - LogPopup
237+ - StashPopup
238+ - BranchPopup
237239
238240## Notification Highlighting
239241
@@ -266,6 +268,7 @@ You can override them to fit your colorscheme by creating a `syntax/NeogitStatus
266268Set ` disable_context_highlighting = true ` in your call to [ ` setup ` ] ( #configuration ) to disable context highlighting altogether.
267269
268270## Disabling Hint
271+
269272Set ` disable_hint = true ` in your call to [ ` setup ` ] ( #configuration ) to hide hints on top of the panel.
270273
271274## Disabling Commit Confirmation
@@ -280,13 +283,13 @@ Set `disable_insert_on_commit = true` in your call to [`setup`](#configuration)
280283
281284Neogit emits the following events:
282285
283- | Event | Description |
284- | ------------------------- | ---------------------------------- |
285- | ` NeogitStatusRefreshed ` | Status has been reloaded |
286- | ` NeogitCommitComplete ` | Commit has been created |
287- | ` NeogitPushComplete ` | Push has completed |
288- | ` NeogitPullComplete ` | Pull has completed |
289- | ` NeogitFetchComplete ` | Fetch has completed |
286+ | Event | Description |
287+ | ----------------------- | ------------------------ |
288+ | ` NeogitStatusRefreshed ` | Status has been reloaded |
289+ | ` NeogitCommitComplete ` | Commit has been created |
290+ | ` NeogitPushComplete ` | Push has completed |
291+ | ` NeogitPullComplete ` | Pull has completed |
292+ | ` NeogitFetchComplete ` | Fetch has completed |
290293
291294You can listen to the events using the following code:
292295
0 commit comments