git-slides

Text-based slides using vim and git.

Overview

Abuse git's history rewriting mechanism by creating one commit for each slide.

Within vim, press Space and Backspace (in normal mode) to move forwards and backwards.

Especially useful for live demos with a lot of canned code, which you want to present and run incrementally.

You only need one file. That file will be your slides (notice the plural). Each change and save will create a new commit. Moving back and forth between slides will checkout the previous or next commit respectively and reload the buffer in vim.

Installation

1. Copy plugin/git-slides.vim to your ~/.vim/plugin or use a plugin manager. For example with vim-plug add the following line to your vimrc (assuming you already have vim-plug installed):

Plug 'gelisam/git-slides'

2. Put git-slides in your path. For example if you installed with vim-plug:

$ cd <destination-dir> && \
    wget https://raw.githubusercontent.com/gelisam/git-slides/master/bin/git-slides && \
    ln -sfv <destination-dir>/git-slides /usr/local/bin/git-slides

Note: When using a plugin manager you might want to make the sym link point to the plugin manager's folder to keep up to date in case git-slides.sh changes.

Mappings

The default mappings are:

  nnoremap <Backspace> :wa<CR>:call system("git-slides prev")<CR>:e!<CR> " previous slide
  nnoremap <Space> :wa<CR>:call system("git-slides next")<CR>:e!<CR> " next slide
  nnoremap sl :wa<CR>:call system("git-slides next")<CR>:e!<CR> " next slide
  nnoremap sh :wa<CR>:call system("git-slides prev")<CR>:e!<CR> " previous slide
  nnoremap sL :call system("git-slides next -f")<CR>:e!<CR> " next slide discarding changes
  nnoremap sH :call system("git-slides prev -f")<CR>:e!<CR> " previous slide discarding changes
  nnoremap ss :wa<CR>:call system("git-slides save")<CR>:e!<CR> " alter the current slide and save
  nnoremap sb :wa<CR>:call system("git-slides insert-before")<CR>:e!<CR> " insert changes as a new slide before the current slide
  nnoremap sa :wa<CR>:call system("git-slides insert-after")<CR>:e!<CR> " insert changes as a new slide after the current slide
  nnoremap st :wa<CR>:call system("git-slides transform")<CR>:e!<CR> " apply changes to all future slides stopping at the first conflict
  nnoremap sd :wa<CR>:call system("git-slides delete")<CR>:e!<CR> " Delete the current slide
  nnoremap sr :!./%<CR " Run the current slide as a command. (useful for command line scripts)>

If you would like to set your own mappings, put this in your .vimrc:

let g:gitslides_use_custom_mappings = 1