You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-4Lines changed: 14 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Easy note taking in Vim
2
2
3
-
The notes.vim plug-in for the [Vim text editor][vim] makes it easy to manage your notes in Vim:
3
+
The vim-notes plug-in for the [Vim text editor][vim] makes it easy to manage your notes in Vim:
4
4
5
5
***Starting a new note:** Execute the `:Note` command to create a new buffer and load the appropriate file type and syntax
6
6
* You can also start a note with Vim commands like `:edit`, `:tabedit` and `:split` by starting the filename with `note:`, as in `:edit note:todo` (the part after `note:` doesn't have to be the complete note title and if it's empty a new note will be created)
@@ -19,13 +19,17 @@ The notes.vim plug-in for the [Vim text editor] [vim] makes it easy to manage yo
19
19
***Writing aids:** The included file type plug-in contains mappings for automatic curly quotes, arrows and list bullets and supports completion of note titles using Control-X Control-U and completion of tags using Control-X Control-O
20
20
***Embedded file types:** The included syntax script supports embedded highlighting using blocks marked with `{{{type … }}}` which allows you to embed highlighted code and configuration snippets in your notes
21
21
22
-
Here's a screen shot of the syntax mode using the [slate][slate] color scheme:
22
+
Here's a screen shot of the syntax mode using the [Slate][slate] color scheme and the font [Monaco][monaco]:
Unzip the most recent [ZIP archive][download] file inside your Vim profile directory (usually this is `~/.vim` on UNIX and `%USERPROFILE%\vimfiles` on Windows), restart Vim and execute the command `:helptags ~/.vim/doc` (use `:helptags ~\vimfiles\doc` instead on Windows). To get started execute `:Note` or `:edit note:`, this will start a new note that contains instructions on how to continue from there (and how to use the plug-in in general).
28
+
*Please note that the vim-notes plug-in requires my vim-misc plug-in which is separately distributed.*
29
+
30
+
Unzip the most recent ZIP archives of the [vim-notes][download-notes] and [vim-misc][download-misc] plug-ins inside your Vim profile directory (usually this is `~/.vim` on UNIX and `%USERPROFILE%\vimfiles` on Windows), restart Vim and execute the command `:helptags ~/.vim/doc` (use `:helptags ~\vimfiles\doc` instead on Windows). To get started execute `:Note` or `:edit note:`, this will start a new note that contains instructions on how to continue from there (and how to use the plug-in in general).
31
+
32
+
If you prefer you can also use [Pathogen][pathogen], [Vundle][vundle] or a similar tool to install & update the [vim-notes][github-notes] and [vim-misc][github-misc] plug-ins using a local clone of the git repository.
29
33
30
34
## Options
31
35
@@ -302,14 +306,19 @@ This software is licensed under the [MIT license] [mit].
0 commit comments