Jekyll Bootstrap Theme¶ ↑
Jekyll Bootstrap Theme is the best of both worlds. Combing the power of Jekyll with Bootstrap. You may use the default template, or make your own.
Usage¶ ↑
To start using the Bootstrap Jekyll Theme:
-
Add the following to your site's
_config.yml
:
yml theme: jekyll-theme-bootstrap
-
Optionally, add the following to your site's
Gemfile
:
ruby gem "github-pages", group: :jekyll_plugins
Development¶ ↑
If you'd like to preview the theme locally (for example, in the process of proposing a change):
-
Clone down the theme's repository (
git clone https://github.com/matrixfox/jekyll-theme-bootstrap
) -
cd
into the theme's directory -
Run
script/bootstrap
to install the necessary dependencies -
Run
bundle exec jekyll serve
to start the preview server -
Visit {
localhost:4000
} in your browser to preview the theme
The theme contains a minimal test suite, to ensure a site with the theme would build successfully. To run the tests, simply run script/cibuild
. You'll need to run script/bootstrap
one before the test script will work.
Contributing¶ ↑
Bug reports and pull requests are welcome on GitHub at github.com/matrixfox/jekyll-theme-bootstrap. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
License¶ ↑
The gem is available as open source under the terms of the MIT License.