https://github.com/michaelcurrin/jekyll-bootstrap-quickstart

Starter template for using Jekyll 4 and the Bootstrap gem - with GitHub Actions
https://github.com/michaelcurrin/jekyll-bootstrap-quickstart

Last synced: 12 months ago
JSON representation

Starter template for using Jekyll 4 and the Bootstrap gem - with GitHub Actions

• Host: GitHub
• URL: https://github.com/michaelcurrin/jekyll-bootstrap-quickstart
• Owner: MichaelCurrin
• License: mit
• Created: 2021-09-08T19:47:08.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2022-01-04T16:34:32.000Z (over 4 years ago)
• Last Synced: 2025-01-14T20:52:42.304Z (over 1 year ago)
• Language: HTML
• Size: 330 KB
• Stars: 3
• Watchers: 3
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Jekyll Bootstrap Quickstart 🧪 🥾 🚀

> Starter template for using Jekyll 4 and the Bootstrap gem

[![GitHub tag](https://img.shields.io/github/tag/MichaelCurrin/jekyll-gh-actions-quickstart?include_prereleases=&sort=semver)](https://github.com/MichaelCurrin/jekyll-bootstrap-quickstart/releases/)

[![License](https://img.shields.io/badge/License-MIT-blue)](#license)

[![Made with Ruby](https://img.shields.io/badge/Ruby->=2.6-blue?logo=ruby&logoColor=white)](https://ruby-lang.org)

[![Made with Jekyll](https://img.shields.io/badge/Jekyll-4.2-blue?logo=jekyll&logoColor=white)](https://jekyllrb.com)

## Preview



    



## About

This project includes the Bootstrap gem. So Bootstrap styling can be loaded as your CSS, without having to use NPM commands.

- [bootstrap](https://rubygems.org/gems/bootstrap) on RubyGems.

- [twbs/bootstrap-rubygem](https://github.com/twbs/bootstrap-rubygem) repo.

## How to use this template



[![Use this template](https://img.shields.io/badge/Generate-Use_this_template-2ea44f?style=for-the-badge)](https://github.com/MichaelCurrin/jekyll-bootstrap-quickstart/generate)



If you want to deploy to GitHub Pages using GitHub Actions, see:

- [MichaelCurrin/jekyll-gh-actions-quickstart](https://github.com/MichaelCurrin/jekyll-gh-actions-quickstart)

Or, add a Netlify config and deploy to Netlify.

## Documentation

### Installation

Install Ruby and Bundler at the user level.

Clone the project or your copy of the template.

Install project dependencies:

```sh

$ make install

```

### Usage

Start dev server:

```sh

$ make serve

```

Open in the browser:

- http://localhost:4000/jekyll-bootstrap-quickstart/

Build:

```sh

$ make build

```

## How it works

- Bootstrap gem is installed using [Gemfile][/Gemfile].

- The [\_config.yml](/_config.yml) is set up to load SASS styling from gems. This extra work is because the gem was not made to be compatible with Jekyll.

- The [styles.scss](/assets/css/styles.scss) file is set up to load from the Bootstrap gem.

## License

Released under [MIT](/LICENSE) by [@MichaelCurrin](https://github.com/MichaelCurrin).