Skip to content
This repository was archived by the owner on Mar 9, 2020. It is now read-only.

Commit ec40091

Browse files
committed
better README; screenshot
1 parent f33b30f commit ec40091

File tree

2 files changed

+22
-2
lines changed

2 files changed

+22
-2
lines changed

README.markdown

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,20 @@
11
## VimFootnotes for Markdown
22

3-
This fork is a slight tweak of the venerable [vimfootnotes](http://www.vim.org/scripts/script.php?script_id=431), for use with extended markdown.
3+
This fork is a slight tweak of the venerable [vimfootnotes][], for use
4+
with extended markdown.
45

56
The original script inserts footnotes that look like this:
67

8+
[vimfootnotes]: http://www.vim.org/scripts/script.php?script_id=431
9+
710
~~~
811
Here is some text.[1]
912
1013
[1] Here is a note.
1114
~~~
1215

13-
The new script inserts footnotes in the widely supported extended markdown syntax,
16+
The new script inserts footnotes in the widely supported extended
17+
markdown syntax,
1418

1519
~~~
1620
Here is some text.[^1]
@@ -22,6 +26,22 @@ The original script inserts footnotes at the end of the file **or**
2226
before your email sig line. The new script inserts all footnotes at the
2327
end of the file.
2428

29+
The script defines two mappings,
30+
31+
~~~
32+
<Leader>f Insert new footnote
33+
<Leader>r Return from footnote
34+
~~~
35+
36+
To insert a footnote, type `<Leader>f`. A footnote reference will be
37+
inserted after the cursor. A matching footnote reference will be
38+
inserted at the end of the file. A new buffer will open in a split
39+
window at the bottom of your screen, ready to edit the new footnote.
40+
When you are done, type `<Leader>r` to close the split and return to
41+
the main text.
42+
43+
![Screenshot](https://raw.github.com/vim-pandoc/vim-markdownfootnotes/master/footnotes.png)
44+
2545
* * * * *
2646
~~~
2747
" Maintainer: David Sanson <[email protected]>

footnotes.png

504 KB
Loading

0 commit comments

Comments
 (0)