@@ -5,13 +5,15 @@ A minimal neovim plugin for taking down notes for git projects and per branch
5
5
![ gitpad.nvim screenshot] ( https://github.com/yujinyuz/gitpad.nvim/assets/10972027/516838f5-9e14-4177-9abc-6f71a4b7feac )
6
6
7
7
## ✨ Features
8
+
8
9
- Provides a per repository / per branch way of note taking while working on your code with the help
9
- of floating windows.
10
+ of floating windows.
10
11
- Supports creating and toggling a separate ` {branch}-branchpad.md ` file for each branch,
11
12
if desired.
12
13
- Extensible note list (daily notes, per-file notes, etc.)
13
14
14
15
## ⚡️ Requirements
16
+
15
17
- Neovim >= 0.7.2
16
18
17
19
Disclaimer: Plugin should work fine with most neovim versions but I have not tested yet
@@ -25,11 +27,12 @@ using [lazy.nvim](https://github.com/folke/lazy.nvim):
25
27
{
26
28
' yujinyuz/gitpad.nvim' ,
27
29
config = function ()
28
- require (' gitpad' ).setup {
30
+ require (' gitpad' ).setup ( {
29
31
-- your configuration comes here
30
32
-- or leave it empty to use the default settings
31
33
-- refer to the configuration section below
32
- },
34
+ })
35
+ end ,
33
36
keys = {
34
37
{
35
38
' <leader>pp' ,
@@ -50,7 +53,7 @@ using [lazy.nvim](https://github.com/folke/lazy.nvim):
50
53
' <leader>pd' ,
51
54
function ()
52
55
local date_filename = ' daily-' .. os.date (' %Y-%m-%d.md' )
53
- require (' gitpad' ).toggle_gitpad { filename = date_filename }
56
+ require (' gitpad' ).toggle_gitpad ( { filename = date_filename })
54
57
end ,
55
58
desc = ' gitpad daily notes' ,
56
59
},
@@ -64,13 +67,13 @@ using [lazy.nvim](https://github.com/folke/lazy.nvim):
64
67
return
65
68
end
66
69
filename = vim .fn .pathshorten (filename , 2 ) .. ' .md'
67
- require (' gitpad' ).toggle_gitpad { filename = filename }
70
+ require (' gitpad' ).toggle_gitpad ( { filename = filename })
68
71
end ,
69
72
desc = ' gitpad per file notes' ,
70
73
},
71
74
},
72
- end
73
75
}
76
+
74
77
```
75
78
76
79
## ⚙︎ Configuration
@@ -106,4 +109,5 @@ require('gitpad').toggle_gitpad_branch()
106
109
```
107
110
108
111
## License
112
+
109
113
This plugin is distributed under the terms of the MIT License.
0 commit comments