vimdeck-without-ascii-art 0.2.9

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e0bf357762ab6d9a2d3d76dcfdad2e46b2e16dd6
+  data.tar.gz: fc9c23616d831c9f6eea5431a5c5893fb7616a53
+SHA512:
+  metadata.gz: c516ca414fb63dda4ce82688b40089624502738ada6a3de69d9c32b461bf7723dcd1fd4f50f5eeccab7a3083fb832373ea5b10fae4b8464cd90110fc3804ed47
+  data.tar.gz: ca11ee7055c3b41848c5875f41463b738bb9c3e68546611e2cbc8770161df81530a9f3e914c53e0df02dfaa98bb32b4e5f86bd743e818ee68591fd76ac618f68

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+gem 'artii', '~>2.0.4'
+gem 'redcarpet', '~>3.1.2'

data/Gemfile.lock

@@ -0,0 +1,14 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    artii (2.0.4)
+    rake (10.1.1)
+    redcarpet (3.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  artii (~> 2.0.4)
+  rake
+  redcarpet (~> 3.1.2)

data/LICENSE.txt

@@ -0,0 +1,21 @@
+
+The MIT License (MIT)
+
+Copyright (c) [year] [fullname]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,138 @@
+# Vimdeck [![Gem Version](https://badge.fury.io/rb/vimdeck.png)](http://badge.fury.io/rb/vimdeck)
+
+VIM as a presentation tool
+
+
+## News
+
+Vimdeck now uses [redcarpet](http://github.com/vmg/redcarpet) to parse and render markdown!
+
+I've cleaned up the code significantly. So those of you who like more features in Vimdeck
+can fork and pull-request your buns off.
+
+
+## Installation
+
+Install a markdown syntax highlighting plugin for VIM. (I recommend [tpope/vim-markdown](http://github.com/tpope/vim-markdown))
+
+Install the VIM plugin [SyntaxRange](https://github.com/vim-scripts/SyntaxRange).
+
+```
+gem install vimdeck
+```
+
+If you have problems getting RMagick to install, try installing [ImageMagick](http://www.imagemagick.org/) explicitly first.
+
+
+## Usage
+
+1. Write your slides in a markdown file (See below for details on _limited_ markdown syntax)
+
+2. Run `vimdeck <file_name.md>` and it will generate a file for each slide and open them in VIM
+
+
+## VIM Script
+
+Vimdeck will also provide a script file that will set up keybindings for you.
+
+- PageUp/Left go backwards
+- PageDown/Right go forward
+- Q closes presentation
+
+
+## A Note about VIM
+
+This is a tool meant for VIM users. In other words, it is not a VIM plugin
+&mdash; it's a script that converts a plain text document into multiple files.
+
+The only hard dependency is [SyntaxRange](https://github.com/vim-scripts/SyntaxRange).
+
+Other than that you may need some syntax highlighting plugins to handle the code syntax highlighting.
+
+
+## A Note About Markdown
+
+Slides are separated by 2 newlines in a row.
+
+Example:
+
+```
+# Slide 1
+
+- has some
+- really important
+- information
+
+
+# Slide 2
+
+Is less important
+```
+
+Vimdeck uses redcarpet to parse its markdown and implements a custom renderer
+for things like ascii art. It uses a very small subset of markdown. List of items supported:
+
+- h1s
+- h2s
+- images
+- fenced code blocks
+
+That's it. The point of Markdown is that it's human-readable. Other stuff like (un)ordered
+lists, block quotes, indented code blocks, etc. will be displayed just as they were written.
+
+Fenced code blocks look like this:
+
+    ```javascript
+       this.is = 'code'
+    ```
+
+## Highlighting Syntax
+
+Vimdeck also supports "highlighting" parts of a slide. This is an experimental feature and needs more testing.
+
+Use `{~ unimportant_text_here ~}` to "unhighlight" portions of a slide:
+
+    # Slide Title
+
+    {~- Unimportant bullet~}
+    - Important bullet
+    {~- Really unimportant bullet~}
+
+This allows you to create multiple versions of the same slide but with different parts highlighted.
+Which is something I like to use often when presenting code snippets.
+
+## Why Ruby?
+
+Additionally, I want to point out that I realize that it's odd to have a VIM-based tool
+and not write it as a VIM script. Ruby was my language of choice only because the ascii art dependencies
+were implemented as ruby gems. Plus, I &hearts; ruby.
+
+
+##Screenshots:
+
+
+Vimdeck converts h1s and h2s into ascii art
+![](img/demo1.png)
+
+
+Lists are displayed as they are written
+![](img/demo2.png)
+
+
+Vimdeck will also augment its vimscript to provide syntax highlighting
+![](img/demo3.png)
+
+
+Images are even converted to ascii art!
+![](img/demo4.png)
+
+
+
+
+---------------------
+
+Made by [tybenz](http://github.com/tybenz): [tybenz.com](http://tybenz.com) // [@tybenz](http://twitter.com/tybenz)
+
+
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/tybenz/vimdeck/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
+

data/Rakefile

@@ -0,0 +1,34 @@
+require "rubygems"
+require "rake"
+
+VERSION = File.read(File.join(".", "VERSION"))
+
+desc "Build gem from gemspec"
+task :build do
+  system "rm *.gem"
+  system "gem build vimdeck.gemspec"
+end
+
+desc "Deploy gem to rubygems.org"
+task :deploy do
+  system "gem push vimdeck-#{VERSION.gsub( /\n/, "" )}.gem"
+end
+
+desc "Tag git repo with release"
+task :tag do
+  system "git tag v#{VERSION}"
+  puts "Tag v#{VERSION} created"
+end
+
+desc "Push tags to github"
+task :push_tags do
+  system "git push --tags origin master"
+end
+
+desc "Release new version: build, deploy, and tag"
+task :release do
+  ["build", "deploy", "tag", "push_tags"].each do |t|
+    Rake::Task[t].reenable
+    Rake::Task[t].invoke
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.9

data/bin/vimdeck

@@ -0,0 +1,110 @@
+#!/usr/bin/env ruby
+#> Usage: vimdeck [<command>] [<file>]
+#>
+#> Commands:
+#>
+#>   slideshow          generate and show slides (default)
+#>   generate           generate slides only
+#>   open               open slides in presentation folder (no file needed)
+#>
+#> Options:
+#>
+#>   --mouse, -m           mouse support for navigating slides
+#>   --no-indent, -I       skip indentation
+#>   --no-ascii, -A        skip ascii headers
+#>   --no-filetype, -n     use vim's plaintext syntax highlighting
+#>   --header-margin, -m   bottom margin for headers. default: 1
+#>   --header-font, -h     specify header font (http://www.figlet.org/fontdb.cgi)
+#>                         foregoes the ability to have small and large headers
+#>   --editor, -e          specify editor to use (e.g., vim, mvim)
+
+require "optparse"
+if ENV["VIMDECK_DEBUG"]
+  require_relative File.dirname(__FILE__)+"/../../lib/vimdeck.rb"
+else
+  require "vimdeck"
+end
+
+def usage
+  File.read(__FILE__).split("\n").grep(/^#>/).each do |line|
+    puts line[3..-1]
+  end
+end
+
+def check_file(file, opt_parser)
+  if !file || !File.exists?(file)
+    usage
+    puts "\nFile does not exist! #{file}"
+    exit 0
+  end
+end
+
+options = {}
+
+opt_parser = OptionParser.new do |opt|
+  opt.on("-A", "--no-ascii") do
+    options[:no_ascii] = true
+  end
+
+  opt.on("-I", "--no-indent") do
+    options[:no_indent] = true
+  end
+
+  opt.on("-h", "--header-font STRING", String) do |option|
+    options[:header_font] = option
+  end
+
+  opt.on("-m", "--mouse") do
+    options[:mouse_enabled] = true
+  end
+
+  opt.on("-n", "--no-filetype") do
+    options[:no_filetype] = true
+  end
+
+  opt.on("-m", "--header-margin NUMBER", Numeric) do |option|
+    options[:header_margin] = option
+  end
+
+  opt.on("-d", "--dos-newlines") do
+    options[:dos_newlines] = true
+  end
+
+  opt.on("-e", "--editor EDITOR", String) do |option|
+    if option == "vim" || option == "mvim" || option == "nvim"
+      options[:editor] = option
+    else
+      raise "Not a valid editor: #{option}"
+    end
+  end
+end
+
+opt_parser.parse!
+
+file = ARGV.length > 1 ? ARGV[1] : ARGV[0]
+
+if !ARGV[0]
+  usage
+  exit 0
+end
+
+if ARGV[0] && ARGV[0] != "open"
+  check_file(file, opt_parser)
+end
+
+case ARGV[0]
+when "slideshow"
+  Vimdeck::Slideshow.start(file, options)
+when "generate"
+  Vimdeck::Slideshow.generate(file, options)
+when "open"
+  if ARGV.length == 2
+    puts "Vimdeck will open already existing slides"
+    puts "File name will be ignored"
+    sleep 3
+  end
+
+  Vimdeck::Slideshow.open
+else
+  Vimdeck::Slideshow.start(file, options)
+end

data/bin/vimdeck-without-ascii-art

@@ -0,0 +1,110 @@
+#!/usr/bin/env ruby
+#> Usage: vimdeck [<command>] [<file>]
+#>
+#> Commands:
+#>
+#>   slideshow          generate and show slides (default)
+#>   generate           generate slides only
+#>   open               open slides in presentation folder (no file needed)
+#>
+#> Options:
+#>
+#>   --mouse, -m           mouse support for navigating slides
+#>   --no-indent, -I       skip indentation
+#>   --no-ascii, -A        skip ascii headers
+#>   --no-filetype, -n     use vim's plaintext syntax highlighting
+#>   --header-margin, -m   bottom margin for headers. default: 1
+#>   --header-font, -h     specify header font (http://www.figlet.org/fontdb.cgi)
+#>                         foregoes the ability to have small and large headers
+#>   --editor, -e          specify editor to use (e.g., vim, mvim)
+
+require "optparse"
+if ENV["VIMDECK_DEBUG"]
+  require_relative File.dirname(__FILE__)+"/../../lib/vimdeck.rb"
+else
+  require "vimdeck"
+end
+
+def usage
+  File.read(__FILE__).split("\n").grep(/^#>/).each do |line|
+    puts line[3..-1]
+  end
+end
+
+def check_file(file, opt_parser)
+  if !file || !File.exists?(file)
+    usage
+    puts "\nFile does not exist! #{file}"
+    exit 0
+  end
+end
+
+options = {}
+
+opt_parser = OptionParser.new do |opt|
+  opt.on("-A", "--no-ascii") do
+    options[:no_ascii] = true
+  end
+
+  opt.on("-I", "--no-indent") do
+    options[:no_indent] = true
+  end
+
+  opt.on("-h", "--header-font STRING", String) do |option|
+    options[:header_font] = option
+  end
+
+  opt.on("-m", "--mouse") do
+    options[:mouse_enabled] = true
+  end
+
+  opt.on("-n", "--no-filetype") do
+    options[:no_filetype] = true
+  end
+
+  opt.on("-m", "--header-margin NUMBER", Numeric) do |option|
+    options[:header_margin] = option
+  end
+
+  opt.on("-d", "--dos-newlines") do
+    options[:dos_newlines] = true
+  end
+
+  opt.on("-e", "--editor EDITOR", String) do |option|
+    if option == "vim" || option == "mvim" || option == "nvim"
+      options[:editor] = option
+    else
+      raise "Not a valid editor: #{option}"
+    end
+  end
+end
+
+opt_parser.parse!
+
+file = ARGV.length > 1 ? ARGV[1] : ARGV[0]
+
+if !ARGV[0]
+  usage
+  exit 0
+end
+
+if ARGV[0] && ARGV[0] != "open"
+  check_file(file, opt_parser)
+end
+
+case ARGV[0]
+when "slideshow"
+  Vimdeck::Slideshow.start(file, options)
+when "generate"
+  Vimdeck::Slideshow.generate(file, options)
+when "open"
+  if ARGV.length == 2
+    puts "Vimdeck will open already existing slides"
+    puts "File name will be ignored"
+    sleep 3
+  end
+
+  Vimdeck::Slideshow.open
+else
+  Vimdeck::Slideshow.start(file, options)
+end