An open API service indexing awesome lists of open source software.

https://github.com/equilaterus/bootlaterus.gh-pages

Integrate Bootstrap into your GithubPages
https://github.com/equilaterus/bootlaterus.gh-pages

Last synced: 8 months ago
JSON representation

Integrate Bootstrap into your GithubPages

Awesome Lists containing this project

README

          

# Bootlaterus GitHub Pages

[![Build Status](https://travis-ci.org/equilaterus/bootlaterus.gh-pages.svg?branch=master)](https://travis-ci.org/equilaterus/bootlaterus.gh-pages) [![GitHub release](https://img.shields.io/github/v/release/equilaterus/bootlaterus.gh-pages?include_prereleases)](https://GitHub.com/equilaterus/bootlaterus.gh-pages/releases/) [![GitHub license](https://img.shields.io/github/license/equilaterus/bootlaterus.gh-pages.svg)](https://github.com/equilaterus/bootlaterus.gh-pages/blob/master/LICENSE)

Easily integrate Bootstrap to your GitHub Pages.

Samples:

* [Basic page](https://equilaterus.github.io/bootlaterus.gh-pages/)
* [Equilaterus.com](https://equilaterus.github.io/)

## Instructions

> This project is based on [Jekyll Minima](https://github.com/jekyll/minima), extending and simplifying the original theme to give it a *Bootstrap-like* flavor.

* Create a [Github Page](https://pages.github.com/).

* Download [Release Assets](https://github.com/equilaterus/bootlaterus.gh-pages/releases/download/v1.0.0/bootlaterus.gh-pages-1.0.0.zip) from this repo.

* Uncompress files on your repo.

* Update *_config.yml* file with your own data.

* Choose a theme updating the file *_includes/head.html*, by uncommenting or adding a link to a Bootstrap Compatible theme. You can freely use [Bootlaterus Open Source Themes](https://github.com/equilaterus/bootlaterus).

* Push changes to your GitHub repo!

## Testing locally

### Option 1: Run util scripts

* Install [Ruby](https://equilaterus.github.io/wikilaterus/wiki/Programming-Ruby.html#install-ruby).

* Run the **PowerShell** files on the *_util* folder:

* **install-site**: run once to install bundler and all dependencies.

* **run-site**: run to start the server.

### Option 2: Commands

* Install [Ruby](https://equilaterus.github.io/wikilaterus/wiki/Github-Pages.html#install-ruby).

* Run the following commands to install the site:

```
gem install bundler
bundle install
```

* Run this command to start the server:

```
bundle exec jekyll serve
```