bb0b5e859a3f85fef5c133f034517fb1a9c9c3a2
[vimslides.git] / README.slides
1                   vimslides -- presentation inside Vim
2 ------------------------------------------------------------------------
3                               |What is it|
4
5     * Trivial Vim predefined commands that will add some highlights
6     * Some keyboard mappings
7     * Nice outlook for displaying presentations
8 ------------------------------------------------------------------------
9                           |Syntax highlights|
10
11     * Emphased text made using |that wrapping characters|
12     * Bold text made using :that wrapping characters:
13     * And another emphasing using <that wrapping characters>
14     * List "*" items are highlighted too
15 ------------------------------------------------------------------------
16                           |Keyboard mappings|
17
18     * :leader + ]: to close current fold, open next one and center on it
19     * :leader + [: same as above, but previous fold
20     * :leader + i: to jump to the next "IMG: path.png" and open that
21       image using external :display: utility
22       IMG:/home/stargrave/pic/b2b-29.webp
23 ------------------------------------------------------------------------
24                             |How to use it|
25
26     * Prepare text file: separate slides using "----" lines
27     * Each slide must be indented
28     * Execute either |:source /path/to/vimslides.vim| ex-command
29       or |vim -u vimslides.vim README.slides|