Home

simple-navigation is a ruby gem for creating navigations (with multiple levels) for your Rails2, Rails3, Rails4, Sinatra or Padrino applications. You can render your navigation as HTML list, link list or breadcrumbs.

To see the gem/plugin in action please visit the online demo.

Update: v3.12.0 has been released. This release introduces the option consider_item_names_as_safe. All item names will be considered unsafe by default as of v3.13.0. So if you have HTML in your item names, please add this option and set it to true.

Table of contents

• About - what is it and how does it work?
• Installation - how to install the gem in your rails app
• Configuration - how to configure your navigation and determine the active navigation item
• Rendering - how to render your navigation in the views
• Styling - how to style your navigation
• Twitter Bootstrap Integration - how to use simple-navigation with Bootstrap
• Dynamic Navigation Items - how the provide the navigation items dynamically
• Demonstration - a live demonstration of simple-navigation
• FAQ - frequently asked questions
• Help - how to get help
• Who is using it? - A list of sites that are using simple-navigation
• Upcoming Features

Ruby Compliance

The simple-navigation gem is tested against the following versions of Ruby:

• 1.9.3
• 2.0.0
• 2.1.1

Credits

We would like to thank the whole community for the feedback and inspiration. Special thanks goes to the following contributors for providing patches, enhancements, ideas and support.

• Simon Courtois
• Markus Schirp
• Jack Dempsey
• Richard Hulse
• Gernot Kogler
• Florian Hanke

Please also check out the complete list of contributors.