RubyGems - glorify - Versions diffs - 0.0.4 → 0.0.5 - Mend

glorify 0.0.4 → 0.0.5

Files changed (8) hide show

data/.gitignore CHANGED Viewed

@@ -1,2 +1,3 @@
 .rvmrc
 pkg/*
+*.swp

data/README.md CHANGED Viewed

@@ -1 +1,108 @@
 # glorify
+Sinatra helper to parse markdown with syntax highlighting like the pros
+Renders via redcarpet with syntax highlighting thanks to albino. Able to use
+fenced code blocks like github, and includes a default pygments stylesheet.
+## install
+```bash
+gem install glorify
+```
+or with bundler
+```ruby
+# Gemfile
+source :rubygems
+gem 'sinatra'
+gem 'glorify'
+```
+## usage
+given the following `markdown` example
+    # a sip of glory
+    providing a sinatra helper, glorify lets you parse markdown with ease.
+    you can even parse code blocks, in any language you'd like. just like you can
+    with github flavored markdown. because glorify uses much of the same technology
+    as github, you can highlight code from nearly any language, without any extra
+    dependencies.
+    the snippet below will render a bit of some ruby with syntax highlighting.
+    ```ruby
+    ['toast', 'cheese', 'wine'].each { |food| print food.capitalize }
+    ```
+### classical app
+simply `require 'glorify'` to use with a classic style sinatra app.
+```ruby
+require 'sinatra'
+require 'glorify'
+require 'erb'
+get '/' do
+  @example = File.open("#{File.dirname(__FILE__)}/example.md", "rb").read
+  erb :index
+end
+```
+### modular app
+you'll need to `register Sinatra::Glorify` in your sub-classed app, along with
+`require 'glorify'`, to use with a modular style sinatra app.
+```ruby
+require 'sinatra/base'
+require 'glorify'
+require 'erb'
+class SubclassedApp < Sinatra::Base
+  register Sinatra::Glorify
+  get '/' do
+    @example = File.open("#{File.dirname(__FILE__)}/example.md", "rb").read
+    erb :index
+  end
+end
+```
+### the view
+this is just a simple `erb` template, but you get the idea.
+```ruby
+<html>
+  <head>
+    <link rel="stylesheet" type="text/css" href="/pygments.css" />
+  </head>
+  <body>
+    <%= glorify @example %>
+  </body>
+</html>
+```
+## license
+```plaintext
+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/lib/glorify/version.rb CHANGED Viewed

@@ -1,5 +1,5 @@
 module Sinatra
   module Glorify
-    VERSION = "0.0.4"
+    VERSION = "0.0.5"
   end
 end

metadata CHANGED Viewed

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: glorify
 version: !ruby/object:Gem::Version
-  hash: 23
+  hash: 21
   prerelease:
   segments:
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors:
 - Zachary Scott
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-03-31 00:00:00 Z
+date: 2012-04-14 00:00:00 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -87,12 +87,8 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
-- LICENSE
 - README.md
 - Rakefile
-- example/app.rb
-- example/example.md
-- example/subclassed_app.rb
 - glorify.gemspec
 - lib/glorify.rb
 - lib/glorify/renderer.rb

data/LICENSE DELETED Viewed

File without changes

data/example/app.rb DELETED Viewed

@@ -1,23 +0,0 @@
-require 'rubygems'
-require 'sinatra'
-require 'glorify'
-require 'erb'
-get '/' do
-  @example = File.open("#{File.dirname(__FILE__)}/example.md", "rb").read
-  erb :index
-end
-__END__
-@@layout
-<html>
-  <head>
-    <link rel="stylesheet" type="text/css" href="/pygments.css" />
-  </head>
-  <body>
-    <%= yield %>
-  </body>
-</html>
-@@index
-<%= glorify @example %>

data/example/example.md DELETED Viewed

@@ -1,14 +0,0 @@
-# a short example of glorify
-this is just a quick example of how to use glorify
-```ruby
-def example
-  puts "Hello, world!"
-end
-example
-  #=> Hello, world!
-```
-That should parse into a code block highlighted for ruby.

data/example/subclassed_app.rb DELETED Viewed

@@ -1,32 +0,0 @@
-require 'rubygems'
-require 'sinatra/base'
-require 'glorify'
-require 'erb'
-class SubclassedApp < Sinatra::Base
-  register Sinatra::Glorify
-  set :views, File.dirname(__FILE__)
-  enable :inline_templates
-  get '/' do
-    @example = File.open("#{File.dirname(__FILE__)}/example.md", "rb").read
-    erb :index
-  end
-  run! if app_file == $0
-end
-__END__
-@@layout
-<html>
-  <head>
-    <link rel="stylesheet" type="text/css" href="/pygments.css" />
-  </head>
-  <body>
-    <%= yield %>
-  </body>
-</html>
-@@index
-<%= glorify @example %>