https://github.com/codeplant/sinatra-simple-navigation
A Sinatra extension to enable creating navigations with the simple-navigation gem. Also works for Padrino.
https://github.com/codeplant/sinatra-simple-navigation
Last synced: 5 months ago
JSON representation
A Sinatra extension to enable creating navigations with the simple-navigation gem. Also works for Padrino.
- Host: GitHub
- URL: https://github.com/codeplant/sinatra-simple-navigation
- Owner: codeplant
- License: mit
- Created: 2010-09-02T09:27:29.000Z (over 15 years ago)
- Default Branch: master
- Last Pushed: 2017-05-15T19:12:44.000Z (over 8 years ago)
- Last Synced: 2025-06-17T14:52:13.225Z (7 months ago)
- Language: Ruby
- Homepage: http://github.com/andi/simple-navigation
- Size: 38.1 KB
- Stars: 37
- Watchers: 2
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.textile
- Changelog: CHANGELOG
- License: LICENSE
Awesome Lists containing this project
README
!https://badge.fury.io/rb/sinatra-simple-navigation.png!:http://badge.fury.io/rb/sinatra-simple-navigation
h1. sinatra-simple-navigation
sinatra-simple-navigation is a sinatra extension enabling the use of the "simple-navigation":http://github.com/codeplant/simple-navigation gem in your sinatra and padrino applications.
h2. Installation
Either manually install the gem
@gem install sinatra-simple-navigation@
or preferably use bundler and add it to your Gemfile
@gem 'sinatra-simple-navigation'@
and run @bundle install@
h2. Usage
h3. Sinatra Applications
h4. Classic Style
To use simple-navigation in your classic style sinatra application, just require 'sinatra/simple-navigation':
require 'rubygems'
require 'sinatra'
require 'sinatra/simple-navigation'
# Your app code goes here
h4. Modular Style
If you're developing a module style sinatra application (i.e. subclassing Sinatra::Base), you have to register Sinatra::SimpleNavigation:
require 'rubygems'
require 'sinatra/base'
require 'sinatra/simple-navigation'
class MyApp < Sinatra::Base
register Sinatra::SimpleNavigation
# Your app code goes here
end
h3. Padrino Applications
Using simple-navigation in your padrino application is similar to the modular sinatra style. In your @app/app.rb@ file:
require 'sinatra/simple-navigation'
class MyApp < Padrino::Application
register Sinatra::SimpleNavigation
# Your app code goes here
end
Instead of requiring sinatra/simple-navigation at the top of the file, you could add this to your Gemfile:
@gem 'sinatra-simple-navigation', :require => 'sinatra/simple-navigation'@
h2. Resources
* simple-navigation source code: "http://github.com/codeplant/simple-navigation":http://github.com/codeplant/simple-navigation
* simple-navigation wiki: "http://wiki.github.com/codeplant/simple-navigation":http://wiki.github.com/codeplant/simple-navigation
* demo project with sample applications for rails, sinatra and padrino: "http://github.com/codeplant/simple-navigation-demo":http://github.com/codeplant/simple-navigation-demo
h2. Legal
Copyright (c) 2014 codeplant GmbH, released under the MIT license