Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Middleman extension to easily generate a Twitter Bootstrap navbar
Ruby

README.md

Middleman Bootstrap Navbar

Gem Version Build Status Dependency Status Code Climate

Middleman extension to easily generate a Twitter Bootstrap navbar

Installation

Add this line to your application's Gemfile:

gem 'middleman-bootstrap-navbar'

And then execute:

$ bundle

Or install it yourself as:

$ gem install middleman-bootstrap-navbar

Requirements

The necessary files from Bootstrap >= 2.0 have to be included separately, they are not part of this gem.

At least the CSS files for the navbar are required, and the JS files for dropdowns and responsive features, if you want to use those in the navbar.

Usage

Activate extension

Activate the extensions in config.rb in your Middleman app:

activate :bootstrap_navbar

Set Bootstrap version

This extension needs to know which Bootstrap version you are using, because the navbar HTML looks different in different Bootstrap versions.

If you're using bootstrap-sass, you're all set because the Boostrap version will be sniffed from the bootstrap-sass version.

Otherwise set the Bootstrap version when activating the extension:

activate :bootstrap_navbar do |bootstrap_navbar|
  bootstrap_navbar.bootstrap_version = '3.0.3'
end

Output HTML

The gem bootstrap-navbar is used to generate the HTML. Please refer to the gem's README and the following Wiki entries for detailed instructions on how to generate the navbar:

Usage with Bootstrap 2.x

Usage with Bootstrap 3.x

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request
Something went wrong with that request. Please try again.