Skip to content
Browse files

flesh out readme closes #1

  • Loading branch information...
1 parent 738149e commit 1ed9745eb8c07f4877cc7d6b75e4e876951dadb4 @zzak committed
Showing with 107 additions and 69 deletions.
  1. 0 LICENSE
  2. +107 −0 README.md
  3. +0 −23 example/app.rb
  4. +0 −14 example/example.md
  5. +0 −32 example/subclassed_app.rb
View
0 LICENSE
No changes.
View
107 README.md
@@ -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.
+```
View
23 example/app.rb
@@ -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 %>
View
14 example/example.md
@@ -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.
-
View
32 example/subclassed_app.rb
@@ -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 %>

0 comments on commit 1ed9745

Please sign in to comment.
Something went wrong with that request. Please try again.