trickster 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f2f241877e715fa105bb4c91978e1a76919bd20
-  data.tar.gz: 1a5bfc1a91559e67432c0a42fc380a033760f5ad
+  metadata.gz: 8abf0ec00cdba39261b1d3e8ec12f02c5301fc50
+  data.tar.gz: 52afc43ab5346d1603f6c428bdda3a09503551dd
 SHA512:
-  metadata.gz: c03827066d8a574e9f86c89eacce7c04f1b2bf5ac2ce4bba0298929ea690598f084ac010be5258f2058843fbb5f990538062352bcefc22884e6899b3d727d98c
-  data.tar.gz: cdf41640486c3a5fab7c29c4c801142b719545648c8b84dc8eabe32dd65215e24d74a21218fbeda07fbeac0568a85746253fa6c7da9f5eb35ce9d196bf101478
+  metadata.gz: f7d87d1ba4af5b9666d863b2e512762f8b3a509719e7643952471510fc23daa166bd25841ffab1a1d766d2121e6d04c772b69f349acdb8473359ce49be404bd2
+  data.tar.gz: 7326e1c0a7ca14180362f6a8dec8e35ae44d848f270a7db2a9517c0e35ebf8f01d4cdf9e6cdf9229926a9f383aee8c767c71e90a0357b7885556068f0a416a28

data/README.rdoc

@@ -47,6 +47,10 @@ Also note that each slide will be in a +section+ tag, with the CSS class of its
 background:: although you can customize each slide based on its CSS class, this option allows you to customize the background of this particular slide.  This is useful for IMAGE slides where you might want to better match the image's colors
 transition:: number of milliseconds to transition to the *next* slide.  The default is in the config object, but this can override it per slide.
 
+== TypeKit Support
+
+When you build your presentation with <tt>trickster build</tt>, you can provide your typekit ID via <tt>-t</tt>.  Note that the fonts won't work unless you serve the page via a webserver, as TypeKit won't serve the fonts for a <tt>file://</tt> URL.  You can do this via <tt>trickster serve</tt>.
+
 == Slide Types
 
 == BULLETS
@@ -168,7 +172,7 @@ Trickster discourages verbose slides with lots of text or lots of bullets. This
 
 == trickster - Bootstrap, generate, and manage your trickster presentation
 
-v0.0.5
+v1.3.1
 
 === Global Options
 === --help
@@ -176,44 +180,48 @@ Show this message
 
 
 
-
 === --version
-
-
+Display the program version
 
 
 
 === Commands
-==== build [slides_file]
+==== Command: <tt>build  [slides_file]</tt>
 Generate the presentation from your slides
 
-
-Given your slides_file (defaults to 'slides' in current directory), generates an HTML
-file (based on --output-file) that, when loaded, can be used to play your presentation.
+Given your slides_file (defaults to 'slides' in current directory), generates an HTML file (based on --output-file) that, when loaded, can be used to play your presentation.
 
 Any .scss files found in the css/ directory will be run through SASS to be converted.
 
-Note that currently, the CSS and JS files included are fixed, so keep all your customizations
-to styles.css/styles.scss and custom.js (these files will not be overwritten when
-you do a trickster update).
+Note that currently, the CSS and JS files included are fixed, so keep all your customizations to styles.css/styles.scss and custom.js (these files will not be overwritten when you do a trickster update).
 ===== Options
-===== -o file
+===== -o|--output-file file
 
 Name of the generated HTML file
 
-[Aliases] --output-file
 [Default Value] index.html
 
 
-==== help command
-Shows a list of commands or help for one command
+===== -t|--type-kit-id id
 
+Your TypeKit ID, if using TypeKit
+
+[Default Value] None
+
+
+==== Command: <tt>help  command</tt>
+Shows a list of commands or help for one command
 
 Gets help for the application or its commands. Can also list the commands in a way helpful to creating a bash-style completion function
-==== init dir_name
-Create a new trickster presentation
+===== Options
+===== -c
+List commands one per line, to assist with shell completion
 
 
+
+==== Command: <tt>init  dir_name</tt>
+Create a new trickster presentation
+
 This will create a completely self-contained presentation that can be run just from the files
 in the directory you name.  It will have a static copy of the JavaScript files, JavaScript third-party
 libraries and CSS files you need to run your trickster application.
@@ -225,25 +233,34 @@ file from your slides.
 Note that if you upgrade trickster, you should run `trickster update` in your slide directory
 to get the latest JavaScript and CSS files.
 ===== Options
-===== -t arg
+===== -t|--theme arg
 
 Specify the syntax highlighting theme to use.  One of arta, ascetic, brown_paper, custom, dark, default, far, github, googlecode, idea, ir_black, magula, monokai, pojoaque, rainbow, school_book, solarized_dark, solarized_light, sunburst, tomorrow, tomorrow-night, tomorrow-night-blue, tomorrow-night-bright, tomorrow-night-eighties, vs, xcode, zenburn.  Use 'custom' to get an scss file you can easily customize.
 
-[Aliases] --theme
 [Default Value] default
 [Must Match] ["arta", "ascetic", "brown_paper", "custom", "dark", "default", "far", "github", "googlecode", "idea", "ir_black", "magula", "monokai", "pojoaque", "rainbow", "school_book", "solarized_dark", "solarized_light", "sunburst", "tomorrow", "tomorrow-night", "tomorrow-night-blue", "tomorrow-night-bright", "tomorrow-night-eighties", "vs", "xcode", "zenburn"]
 
 
-==== update [dir_name]
-Update your slideshow with files provided by trickster
+==== Command: <tt>serve </tt>
+Serve your presentation on a local port
+
+If using TypeKit, you'll need to actually run your presentation on a web server so the fonts will be downloaded.  This is an easy way to do that without having to mess with any other gems, libraries, or configuration.
+===== Options
+===== -p|--port port
 
+Port on which to run
+
+[Default Value] 9090
+
+
+==== Command: <tt>update  [dir_name]</tt>
+Update your slideshow with files provided by trickster
 
 
 ===== Commands
-====== files slide_dir
+====== Command: <tt>files  slide_dir</tt>
 Update the trickster JS/CSS files when you've updated the trickster gem
 
-
 Run this after you've upgraded trickster and want to get the latest features.  Since your 
   slideshow is entirely self-contained, when you upgrade trickster, your static JavaScript and
   CSS files will be out of date.
@@ -251,19 +268,17 @@ Run this after you've upgraded trickster and want to get the latest features.  S
   Note that `styles.css`, which was provided by trickster as a basis for styling, will not
   be touched, and your customizations will remain. All other files that trickster gave you
   when you ran `trickster init` will be overwritten.
-====== theme slide_dir
+====== Command: <tt>theme  slide_dir</tt>
 Update the syntax-highlighting theme for your presentation
 
-
 A normal 'trickster update' will leave your theme.css alone, since you can customize it.  This will overwrite
   your existing theme.css with the theme from trickster that you specify.  You should check your presentation
   into source control to avoid the destructive nature of this command.
 ======= Options
-======= -t slide_dir
+======= -t|--theme slide_dir
 
 Specify the syntax highlighting theme to use.  One of arta, ascetic, brown_paper, custom, dark, default, far, github, googlecode, idea, ir_black, magula, monokai, pojoaque, rainbow, school_book, solarized_dark, solarized_light, sunburst, tomorrow, tomorrow-night, tomorrow-night-blue, tomorrow-night-bright, tomorrow-night-eighties, vs, xcode, zenburn.  Use 'custom' to get an scss file you can easily customize.
 
-[Aliases] --theme
 [Default Value] default
 [Must Match] ["arta", "ascetic", "brown_paper", "custom", "dark", "default", "far", "github", "googlecode", "idea", "ir_black", "magula", "monokai", "pojoaque", "rainbow", "school_book", "solarized_dark", "solarized_light", "sunburst", "tomorrow", "tomorrow-night", "tomorrow-night-blue", "tomorrow-night-bright", "tomorrow-night-eighties", "vs", "xcode", "zenburn"]
 A normal 'trickster update' will leave your theme.css alone, since you can customize it.  This will overwrite

data/bin/trickster

@@ -133,23 +133,43 @@ command :update do |c|
   c.default_command :files
 end
 
+desc 'Serve your presentation on a local port'
+long_desc <<EOS
+If using TypeKit, you'll need to actually run your presentation on a web server so the fonts will be downloaded.  This is an easy way to do that without having to mess with any other gems, libraries, or configuration.
+EOS
+command :serve do |c|
+  c.desc          'Port on which to run'
+  c.arg_name      'port'
+  c.default_value '9090'
+  c.flag          [:p,:port]
+
+  c.action do |global_options,options,args|
+    command = "ruby -run -e httpd . -p #{options[:port]}"
+    unless system(command)
+      STDERR.puts "Problem running '#{command}'"
+    end
+  end
+
+end
+
 desc 'Generate the presentation from your slides'
 arg_name '[slides_file]'
 long_desc <<EOS
-Given your slides_file (defaults to 'slides' in current directory), generates an HTML
-file (based on --output-file) that, when loaded, can be used to play your presentation.
+Given your slides_file (defaults to 'slides' in current directory), generates an HTML file (based on --output-file) that, when loaded, can be used to play your presentation.
 
 Any .scss files found in the css/ directory will be run through SASS to be converted.
 
-Note that currently, the CSS and JS files included are fixed, so keep all your customizations
-to styles.css/styles.scss and custom.js (these files will not be overwritten when
-you do a trickster update).
+Note that currently, the CSS and JS files included are fixed, so keep all your customizations to styles.css/styles.scss and custom.js (these files will not be overwritten when you do a trickster update).
 EOS
 command :build do |c|
   c.desc          'Name of the generated HTML file'
   c.arg_name      'file'
   c.default_value 'index.html'
   c.flag          [:o,'output-file']
+  
+  c.desc          'Your TypeKit ID, if using TypeKit'
+  c.arg_name      'id'
+  c.flag          [:t,'type-kit-id']
 
   c.action do |global_options,options,args|
     file    = File.open(args.shift || 'slides')
@@ -159,6 +179,8 @@ command :build do |c|
     body    = parser.body
     title   = parser.title
 
+    typekit_id = options[:'type-kit-id']
+
     erb = ERB.new(File.new(File.expand_path(File.join(File.dirname(__FILE__),'..','erb','index.html.erb'))).readlines.join(""))
     File.open(options[:'output-file'],"w") do |file|
       file.puts erb.result(binding)
@@ -170,6 +192,8 @@ command :build do |c|
         STDERR.puts "Problem running '#{command}'"
       end
     end
+
+    puts "Note that typekit won't work unless you serve your presentation via a web server" if typekit_id
   end
 end
 

data/erb/index.html.erb

@@ -29,6 +29,10 @@
 
       });
     </script>
+    <% if typekit_id %>
+    <script src="//use.typekit.net/<%= typekit_id %>.js"></script>
+    <script>try{Typekit.load();}catch(e){}</script>
+    <% end %>
   </head>
   <body><div id="contents">
     <%= body %>

data/lib/trickster/version.rb

@@ -1,3 +1,3 @@
 module Trickster
-  VERSION = '1.3.1'
+  VERSION = '1.4.0'
 end

data/trickster.gemspec

@@ -5,7 +5,7 @@ spec = Gem::Specification.new do |s|
   s.version = Trickster::VERSION
   s.author = 'David Copeland'
   s.email = 'davetron5000@gmail.com'
-  s.homepage = 'http://your.website.com'
+  s.homepage = 'http://davetron5000.github.io/trickster'
   s.platform = Gem::Platform::RUBY
   s.summary = 'Generate and manage in-browser presentation-slides'
   s.description = 'Make aweomse technical presentation with big fonts that size to fit, and awesome syntax highlighting'
@@ -14,7 +14,7 @@ spec = Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
   s.has_rdoc = true
-  s.extra_rdoc_files = ['README.rdoc','trickster.rdoc']
+  s.extra_rdoc_files = ['README.rdoc']
   s.rdoc_options << '--title' << 'trickster' << '--main' << 'README.rdoc' << '-ri'
   s.bindir = 'bin'
   s.add_development_dependency('rake')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trickster
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - David Copeland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-07 00:00:00.000000000 Z
+date: 2014-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -116,7 +116,6 @@ executables:
 extensions: []
 extra_rdoc_files:
 - README.rdoc
-- trickster.rdoc
 files:
 - .gitignore
 - .ruby-gemset
@@ -255,8 +254,7 @@ files:
 - test/test_helper.rb
 - test_slides
 - trickster.gemspec
-- trickster.rdoc
-homepage: http://your.website.com
+homepage: http://davetron5000.github.io/trickster
 licenses: []
 metadata: {}
 post_install_message: 
@@ -280,7 +278,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Generate and manage in-browser presentation-slides

data/trickster.rdoc

@@ -1,105 +0,0 @@
-== trickster - Bootstrap, generate, and manage your trickster presentation
-
-v0.0.5
-
-=== Global Options
-=== --help
-Show this message
-
-
-
-
-=== --version
-
-
-
-
-
-=== Commands
-==== build [slides_file]
-Generate the presentation from your slides
-
-
-Given your slides_file (defaults to 'slides' in current directory), generates an HTML
-file (based on --output-file) that, when loaded, can be used to play your presentation.
-
-Any .scss files found in the css/ directory will be run through SASS to be converted.
-
-Note that currently, the CSS and JS files included are fixed, so keep all your customizations
-to styles.css/styles.scss and custom.js (these files will not be overwritten when
-you do a trickster update).
-===== Options
-===== -o file
-
-Name of the generated HTML file
-
-[Aliases] --output-file
-[Default Value] index.html
-
-
-==== help command
-Shows a list of commands or help for one command
-
-
-Gets help for the application or its commands. Can also list the commands in a way helpful to creating a bash-style completion function
-==== init dir_name
-Create a new trickster presentation
-
-
-This will create a completely self-contained presentation that can be run just from the files
-in the directory you name.  It will have a static copy of the JavaScript files, JavaScript third-party
-libraries and CSS files you need to run your trickster application.
-
-You can examine the file `slides` to see some examples of how to format your
-presentation.  You can run `trickster build` in the directory to create the HTML
-file from your slides.
-
-Note that if you upgrade trickster, you should run `trickster update` in your slide directory
-to get the latest JavaScript and CSS files.
-===== Options
-===== -t arg
-
-Specify the syntax highlighting theme to use.  One of arta, ascetic, brown_paper, custom, dark, default, far, github, googlecode, idea, ir_black, magula, monokai, pojoaque, rainbow, school_book, solarized_dark, solarized_light, sunburst, tomorrow, tomorrow-night, tomorrow-night-blue, tomorrow-night-bright, tomorrow-night-eighties, vs, xcode, zenburn.  Use 'custom' to get an scss file you can easily customize.
-
-[Aliases] --theme
-[Default Value] default
-[Must Match] ["arta", "ascetic", "brown_paper", "custom", "dark", "default", "far", "github", "googlecode", "idea", "ir_black", "magula", "monokai", "pojoaque", "rainbow", "school_book", "solarized_dark", "solarized_light", "sunburst", "tomorrow", "tomorrow-night", "tomorrow-night-blue", "tomorrow-night-bright", "tomorrow-night-eighties", "vs", "xcode", "zenburn"]
-
-
-==== update [dir_name]
-Update your slideshow with files provided by trickster
-
-
-
-===== Commands
-====== files slide_dir
-Update the trickster JS/CSS files when you've updated the trickster gem
-
-
-Run this after you've upgraded trickster and want to get the latest features.  Since your 
-  slideshow is entirely self-contained, when you upgrade trickster, your static JavaScript and
-  CSS files will be out of date.
-
-  Note that `styles.css`, which was provided by trickster as a basis for styling, will not
-  be touched, and your customizations will remain. All other files that trickster gave you
-  when you ran `trickster init` will be overwritten.
-====== theme slide_dir
-Update the syntax-highlighting theme for your presentation
-
-
-A normal 'trickster update' will leave your theme.css alone, since you can customize it.  This will overwrite
-  your existing theme.css with the theme from trickster that you specify.  You should check your presentation
-  into source control to avoid the destructive nature of this command.
-======= Options
-======= -t slide_dir
-
-Specify the syntax highlighting theme to use.  One of arta, ascetic, brown_paper, custom, dark, default, far, github, googlecode, idea, ir_black, magula, monokai, pojoaque, rainbow, school_book, solarized_dark, solarized_light, sunburst, tomorrow, tomorrow-night, tomorrow-night-blue, tomorrow-night-bright, tomorrow-night-eighties, vs, xcode, zenburn.  Use 'custom' to get an scss file you can easily customize.
-
-[Aliases] --theme
-[Default Value] default
-[Must Match] ["arta", "ascetic", "brown_paper", "custom", "dark", "default", "far", "github", "googlecode", "idea", "ir_black", "magula", "monokai", "pojoaque", "rainbow", "school_book", "solarized_dark", "solarized_light", "sunburst", "tomorrow", "tomorrow-night", "tomorrow-night-blue", "tomorrow-night-bright", "tomorrow-night-eighties", "vs", "xcode", "zenburn"]
-A normal 'trickster update' will leave your theme.css alone, since you can customize it.  This will overwrite
-  your existing theme.css with the theme from trickster that you specify.  You should check your presentation
-  into source control to avoid the destructive nature of this command.
-
-[Default Command] files