/nerd-slides-vim-plugin

a vim plugin to keep your presentations/slides nerdy 🤓

Primary LanguageVim ScriptMIT LicenseMIT

███╗   ██╗███████╗██████╗ ██████╗     ███████╗██╗     ██╗██████╗ ███████╗███████╗
████╗  ██║██╔════╝██╔══██╗██╔══██╗    ██╔════╝██║     ██║██╔══██╗██╔════╝██╔════╝
██╔██╗ ██║█████╗  ██████╔╝██║  ██║    ███████╗██║     ██║██║  ██║█████╗  ███████╗
██║╚██╗██║██╔══╝  ██╔══██╗██║  ██║    ╚════██║██║     ██║██║  ██║██╔══╝  ╚════██║
██║ ╚████║███████╗██║  ██║██████╔╝    ███████║███████╗██║██████╔╝███████╗███████║
╚═╝  ╚═══╝╚══════╝╚═╝  ╚═╝╚═════╝     ╚══════╝╚══════╝╚═╝╚═════╝ ╚══════╝╚══════╝
                                                                               🐡

a vim plugin to keep your presentations/slides nerdy 🤓

Features

  • jump to the next slide

    every slide has to start with a horizontal rule in markdown syntax ---, ___ or *** in order to be found

  • jump to the previous slide
  • plot an image

    one line under the horizontal rule (---, ___ or ***) define the image in markdown syntax
    ![image name](/path/to/image)

Requirements

Installation

without plugin manager
  1. In the terminal, 
    mkdir -p ~/.vim/bundle/
git clone https://github.com/roymanigley/nerd-slides-vim-plugin.git ~/.vim/bundle/nerd-slides-vim-plugin
mkdir -p ~/.vim/plugin/
ln -s ~/.vim/bundle/nerd-slides-vim-plugin/plugin/NerdSlides.vim ~/.vim/plugin/NerdSlides.vim
  2. Restart Vim
Pathogen Pathogen is more of a runtime path manager than a plugin manager. You must clone the plugins' repositories yourself to a specific location, and Pathogen makes sure they are available in Vim.
  1. In the terminal, 
    git clone https://github.com/roymanigley/nerd-slides-vim-plugin.git ~/.vim/bundle/.nerd-slides-vim-plugin
  2. In your vimrc, 
    call pathogen#infect()
syntax on
filetype plugin indent on
  3. Restart Vim
Vundle
  1. Install Vundle, according to its instructions.
  2. Add the following text to your vimrc. 
    call vundle#begin()
  Plugin 'roymanigley/nerd-slides-vim-plugin'
call vundle#end()
  3. Restart Vim, and run the :PluginInstall statement to install your plugins.
Vim-Plug
  1. Install Vim-Plug, according to its instructions.
  2. Add the following text to your vimrc.
call plug#begin()
  Plug 'roymanigley/nerd-slides-vim-plugin'
call plug#end()
  1. Restart Vim, and run the :PlugInstall statement to install your plugins.
Dein
  1. Install Dein, according to its instructions.
  2. Add the following text to your vimrc. 
    call dein#begin()
  call dein#add('roymanigley/nerd-slides-vim-plugin')
call dein#end()
  3. Restart Vim, and run the :call dein#install() statement to install your plugins.

Example Usage

  • bind the keys CTRL+DOWN to jump to the next slide
  • bind the keys CTRL+UP to jump to the previous slide
nnoremap <C-down> :call NerdSlides#next()<CR>
nnoremap <C-up> :call NerdSlides#previous()<CR>
  • overwrite the defult image background color 300a24 (default ubuntu background color)
let g:NerdSlides_ImageBackgroundColor = "none"

Examles

Usage

example-presentation