RubyGems - vimdeck - Versions diffs - 0.0.8 → 0.0.9 - Mend

vimdeck 0.0.8 → 0.0.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (30) hide show

data/README.md CHANGED Viewed

@@ -3,29 +3,97 @@
 VIM as a presentation tool
+## Installation
+Install the vim plugin [SyntaxRange](https://github.com/vim-scripts/SyntaxRange).
+```
+gem install vimdeck
+```
 ## Usage
-1. Write your slides in a markdown file
+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
-2. Run `bin/vimdeck` 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
+- PageUp/Left go backwards
+- PageDown/Right go forward
+## 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 does not compile markdown into something else.
+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'
+    ```
+# 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)

data/VERSION CHANGED Viewed

	@@ -1 +1 @@
1	- 0.0.8
1	+ 0.0.9

data/img/demo1.png CHANGED Viewed

Binary file

data/img/demo2.png CHANGED Viewed

Binary file

data/img/demo3.png CHANGED Viewed

Binary file

data/img/demo4.png CHANGED Viewed

Binary file

data/slides.md CHANGED Viewed

@@ -8,39 +8,37 @@
 ![](img/vim.png)
-## Numbered List
+## NUMBERED LIST
 1. This is how a numbered list
 2. Looks in vimdeck
 3. What do you think?
-# Bullets
+# BULLETS
 • First
 {~• Second
 • Third~}
-# Bullets
+# BULLETS
 {~• First~}
 • Second
 {~• Third~}
-# Bullets
+# BULLETS
 {~• First
 • Second~}
 • Third
-#
+## CODE
 ```ruby
-# VIMDECK DOES CODE!
 module Parts
   class foo
     def slide
@@ -55,11 +53,9 @@ end
 ```
-#
+## CODE
 ```ruby
-# VIMDECK DOES CODE!
 {~module Parts
   class foo
     def slide
@@ -74,11 +70,9 @@ end~}
 ```
-#
+## CODE
 ```ruby
-# VIMDECK DOES CODE!
 {~module Parts
   class foo
     def slide
@@ -93,11 +87,9 @@ end~}
 ```
-#
+## CODE
 ```ruby
-# VIMDECK DOES CODE!
 {~module Parts
   class foo
     def slide
@@ -112,11 +104,9 @@ end~}
 ```
-#
+## CODE
 ```ruby
-# VIMDECK DOES CODE!
 {~module~} Parts
   {~class foo
     def slide
@@ -131,11 +121,9 @@ end~}
 ```
-#
+## CODE
 ```ruby
-# VIMDECK DOES CODE!
 {~module Parts
   class foo
     def slide~}
@@ -150,11 +138,9 @@ end~}
 ```
-#
+## CODE
 ```ruby
-# VIMDECK DOES CODE!
 {~module Parts
   class foo
     def~} slide

data/vimdeck.gemspec CHANGED Viewed

@@ -20,4 +20,6 @@ Gem::Specification.new do |s|
   s.files        = FileList['**/**/*'].exclude /.git|.svn|.DS_Store/
   s.bindir       = 'bin'
   s.executables  = ['vimdeck']
+  s.add_runtime_dependency 'artii'
+  s.add_runtime_dependency 'asciiart'
 end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vimdeck
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
   prerelease:
 platform: ruby
 authors:
@@ -10,7 +10,39 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2013-09-18 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: artii
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: asciiart
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: VIM as a presentation tool
 email: tabenziger@gmail.com
 executables:
@@ -29,30 +61,9 @@ files:
 - lib/templates/script.vim.erb
 - lib/test
 - lib/vimdeck.rb
-- presentation/script.vim
-- presentation/slide001.md
-- presentation/slide002.md
-- presentation/slide003.md
-- presentation/slide004.md
-- presentation/slide005.md
-- presentation/slide006.md
-- presentation/slide007.md
-- presentation/slide008.md
-- presentation/slide009.md
-- presentation/slide010.md
-- presentation/slide011.md
-- presentation/slide012.md
-- presentation/slide013.md
-- presentation/slide014.md
-- presentation/slide015.md
-- presentation/slide016.md
-- presentation/slide017.md
-- presentation/slide018.md
-- presentation/slide019.md
 - README.md
 - slides.md
 - VERSION
-- vimdeck-0.0.7.gem
 - vimdeck.gemspec
 homepage: http://github.com/tybenz/vimdeck
 licenses:

data/presentation/script.vim DELETED Viewed

@@ -1,109 +0,0 @@
-noremap <PageUp> :bp<CR>
-noremap <Left> :bp<CR>
-noremap <PageDown> :bn<CR>
-noremap <Right> :bn<CR>
-b 1
-b 2
-b 3
-b 4
-call matchadd("Comment", "• Second\\n           • Third\\(\\_.*slide 4\\)\\@=")
-b 5
-call matchadd("Comment", "• First\\(\\_.*slide 5\\)\\@=")
-call matchadd("Comment", "• Third\\(\\_.*slide 5\\)\\@=")
-b 6
-call matchadd("Comment", "• First\\n           • Second\\(\\_.*slide 6\\)\\@=")
-b 7
-2,14SyntaxInclude ruby
-b 8
-2,14SyntaxInclude ruby
-call matchadd("Comment", "module Parts\\n             class foo\\n               def slide\\n                \"of a\"\\n               end\\n\\n               def can\\n                 highlight = \\(\\_.*slide 8\\)\\@=")
-call matchadd("Comment", "\\n               end\\n             end\\n           end\\(\\_.*slide 8\\)\\@=")
-b 9
-2,14SyntaxInclude ruby
-call matchadd("Comment", "module Parts\\n             class foo\\n               def slide\\n                \"of a\"\\n               end\\n\\n               def\\(\\_.*slide 9\\)\\@=")
-call matchadd("Comment", "highlight = \"vimdeck\"\\n               end\\n             end\\n           end\\(\\_.*slide 9\\)\\@=")
-b 10
-2,14SyntaxInclude ruby
-call matchadd("Comment", "module Parts\\n             class foo\\n               def slide\\n                \"of a\"\\n               end\\n\\n               def can\\(\\_.*slide 10\\)\\@=")
-call matchadd("Comment", "= \"vimdeck\"\\n               end\\n             end\\n           end\\(\\_.*slide 10\\)\\@=")
-b 11
-2,14SyntaxInclude ruby
-call matchadd("Comment", "module\\(\\_.*slide 11\\)\\@=")
-call matchadd("Comment", "class foo\\n               def slide\\n                \"of a\"\\n               end\\n\\n               def can\\n                 highlight = \"vimdeck\"\\n               end\\n             end\\n           end\\(\\_.*slide 11\\)\\@=")
-b 12
-2,14SyntaxInclude ruby
-call matchadd("Comment", "module Parts\\n             class foo\\n               def slide\\(\\_.*slide 12\\)\\@=")
-call matchadd("Comment", "end\\n\\n               def can\\n                 highlight = \"vimdeck\"\\n               end\\n             end\\n           end\\(\\_.*slide 12\\)\\@=")
-b 13
-2,14SyntaxInclude ruby
-call matchadd("Comment", "module Parts\\n             class foo\\n               def\\(\\_.*slide 13\\)\\@=")
-call matchadd("Comment", "\"of a\"\\n               end\\n\\n               def can\\n                 highlight = \"vimdeck\"\\n               end\\n             end\\n           end\\(\\_.*slide 13\\)\\@=")
-b 14
-b 1

data/presentation/slide001.md DELETED Viewed

@@ -1,92 +0,0 @@
-            _    ________  _______  ______________ __
-           | |  / /  _/  |/  / __ \/ ____/ ____/ //_/
-           | | / // // /|_/ / / / / __/ / /   / ,<
-           | |/ // // /  / / /_/ / /___/ /___/ /| |
-           |___/___/_/  /_/_____/_____/\____/_/ |_|
-              ___  __  _____  ____  ___ _      ______________  __  _______
-             / _ \/ / / / _ \/ __/ / _ | | /| / / __/ __/ __ \/  |/  / __/
-            / ___/ /_/ / , _/ _/  / __ | |/ |/ / _/_\ \/ /_/ / /|_/ / _/
-           /_/   \____/_/|_/___/ /_/ |_|__/|__/___/___/\____/_/  /_/___/
-           slide 1

data/presentation/slide002.md DELETED Viewed

@@ -1,105 +0,0 @@
-            _    ________  ___   ____  ____  ________ _______ __
-           | |  / /  _/  |/  /  / __ \/ __ \/ ____/ //_/ ___// /
-           | | / // // /|_/ /  / /_/ / / / / /   / ,<  \__ \/ /
-           | |/ // // /  / /  / _, _/ /_/ / /___/ /| |___/ /_/
-           |___/___/_/  /_/  /_/ |_|\____/\____/_/ |_/____(_)
-           +------------------------------+
-           |              :..             |
-           |   ~===..=+.++==:.+==+======. |
-           |   ~oooooooo==~:..+=oooooooo~ |
-           |    .+oo=oo=::....:=oooooo+.. |
-           |    .=ooooo=.::::+ooooo=++.   |
-           |    .=ooooo=:+:+ooooo=+:~+.   |
-           | ..:.=ooo=o==+ooooo=+:.::.... |
-           |.+::.=oooooooooooo+::.........|
-           |  ..:ooooooooo====:.......:.  |
-           |    .ooooooooo+++:.........   |
-           |    .=ooooo==~~==.+=++==+=+.  |
-           |    .=ooo==~:.++.:=+.==+.==.  |
-           |    .=oo=:..:+=:=o=.:=+~=+.   |
-           |     .~~.   ..::~:. ~..~..~   |
-           |               .~             |
-           +------------------------------+
-           slide 2

data/presentation/slide003.md DELETED Viewed

@@ -1,89 +0,0 @@
-              _  __           __                 __  __   _    __
-             / |/ /_ ____ _  / / ___ _______ ___/ / / /  (_)__/ /_
-            /    / // /  ' \/ _ \ -_) __/ -_) _  / / /__/ (_-< __/
-           /_/|_/\_,_/_/_/_/_.__\__/_/  \__/\_,_/ /____/_/___\__/
-           1. This is how a numbered list
-           2. Looks in vimdeck
-           3. What do you think?
-           slide 3