Middleman Bootstrap Navbar
Middleman extension to easily generate a 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
Middleman
Middleman >= 3.1
Bootstrap
Bootstrap >= 2.0
The necessary Bootstrap files 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 gem needs to know which Bootstrap version you are using, because the navbar HTML looks different in different Bootstrap versions.
If you're using either the bootstrap-sass
or bootstrap
gem, you're all set because the Boostrap version will be sniffed automatically from those gems' versions. Make sure to include the bootstrap-sass
or bootstrap
gem before rails_bootstrap_navbar
in your Gemfile though.
If you include the Bootstrap CSS and JS some other way, you need to set the Bootstrap version when activating the extension:
activate :bootstrap_navbar do |bootstrap_navbar|
bootstrap_navbar.bootstrap_version = '4.0.0'
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:
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request
Support
If you like this project, consider buying me a coffee! :)