Skip to content

Commit 7a9e923

Browse files
committed
Improve documentation notes (thanks to Laurent & SteP)
1 parent 8759b17 commit 7a9e923

File tree

3 files changed

+10
-8
lines changed

3 files changed

+10
-8
lines changed

doc/notes.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Here's a screen shot of the syntax mode using the slate [3] color scheme:
4242

4343
Syntax mode screen shot, see reference [4]
4444

45-
==============================================================================
45+
===============================================================================
4646
*notes-install-usage*
4747
Install & usage ~
4848

@@ -53,7 +53,7 @@ restart Vim and execute the command ':helptags ~/.vim/doc' (use ':helptags
5353
note:', this will start a new note that contains instructions on how to
5454
continue from there (and how to use the plug-in in general).
5555

56-
==============================================================================
56+
===============================================================================
5757
*notes-contact*
5858
Contact ~
5959

@@ -62,14 +62,14 @@ contacted at peter@peterodding.com. The latest version is available at
6262
http://peterodding.com/code/vim/notes/ and http://github.com/xolox/vim-notes.
6363
If you like the script please vote for it on Vim Online [6].
6464

65-
==============================================================================
65+
===============================================================================
6666
*notes-license*
6767
License ~
6868

6969
This software is licensed under the MIT license [7]. Copyright 2011 Peter
7070
Odding <peter@peterodding.com>.
7171

72-
==============================================================================
72+
===============================================================================
7373
*notes-references*
7474
References ~
7575

misc/notes/shadow/New note

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ automatically based on the title.
77
* * *
88

99
The notes plug-in comes with self hosting documentation. To jump to these notes
10-
position your text on the highlighted name and press ‘gf’ in normal mode:
10+
position your cursor on the highlighted name and press ‘gf’ in normal mode:
1111

1212
• Note taking syntax
1313
• Note taking commands

misc/notes/shadow/Note taking syntax

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
Note taking syntax
22

33
This note contains examples of the syntax highlighting styles supported by the
4-
notes plug-in.
4+
notes plug-in. When your Vim configuration supports concealing of text, the
5+
markers which enable the syntax highlighting won’t be visible. In this case you
6+
can make the markers visible by selecting the text.
57

68
# Headings
79

@@ -21,8 +23,8 @@ Hyper links and such:
2123
• Hyper links: http://www.vim.org/, sftp://server/file
2224
• Domain names: www.python.org
2325
• E-mail addresses: user@host.ext
24-
• UNIX filenames: ~/.vim/notes
25-
• Windows filenames: ~\vimfiles\notes
26+
• UNIX filenames: ~/relative/to/home, /absolute/path
27+
• Windows filenames: ~\relative\to\home, c:\absolute\path, \\server\share
2628

2729
# Lists
2830

0 commit comments

Comments
 (0)