https://github.com/sgpinkus/jekyll-bootstrap-structure
Jekyll theme that uses bootstrap 3 for layout.
https://github.com/sgpinkus/jekyll-bootstrap-structure
Last synced: 9 months ago
JSON representation
Jekyll theme that uses bootstrap 3 for layout.
- Host: GitHub
- URL: https://github.com/sgpinkus/jekyll-bootstrap-structure
- Owner: sgpinkus
- License: mit
- Created: 2017-07-08T03:28:00.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T05:07:55.000Z (about 1 year ago)
- Last Synced: 2025-02-13T14:17:59.501Z (11 months ago)
- Language: HTML
- Size: 1.44 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Overview
Provides a scaffold for a HTML site based on [bootstrap's](https://getbootstrap.com/docs/3.3/) [grid system](https://getbootstrap.com/docs/3.3/css/#grid) and bootstrap framework in general. See [Layout](#layout).
# Installation
There is two ways to install jekyll themes: 1. Clone the repo and add start adding your content to a fork. 2. Install as a jekyll ruby gem. Following only covers the former method ...
### Install Jekyll
```
sudo apt-get install ruby-full build-essential zlib1g-dev
```
### Build
```
git clone https://github.com/sgpinkus/jekyll-bootstrap-structure.git my-site && cd my-site
export GEM_HOME="$HOME/ruby/gems" # Dont have to do this. Just depends where you wnat ruby crap to get installed.
export PATH="$HOME/ruby/gems/bin:$PATH"
bundle i
npm i
edit _config.yml _fronts/* # Edit pages.
jekyll build
jekyll serve # Test locally
```
### Host on Github
```
git remote add origin ...
git subtree split --prefix=_site -b gh-pages
git push origin gh-pages
```
# Configuration
This is a list of all site configuration variables used in templates. See [_config.yml](_config.yml) sample configuration.
title
email
google_analytics_id
designer
navbar.menu
navbar.social
navbar.logo
defaults.structure.aside
defaults.structure.banner
defaults.structure.footer.nav-two
defaults.structure.footer.nav-three
# Layout
Below is the HTML structure this theme provides: Items below with "#" are identified by their `id` attribute. Others are identified by tag name. Items in "[]" are optional. Their inclusion depends on configuration. See [Configuration](#configuration).
html
body
header
[#banner]
#navbar
article
#content
[#aside]
footer
#footer-nav
[#footer-nav-two]
[#footer-nav-three]
Layout rules:
+ body is always at least 100% of screen.
+ #content stretches to fill that space not take by header, footer.
+ header, article, footer are always 100% width of screen.
+ #content, banner, #navbar, #footer-navbar[-XXX] may be full width or limited to 1280px
+ #footer-navbar stretches in absence of footer-navbar-(two|three).
# Default Content
There is basic default pages for a basic site in `pages/` directory. These default pages are excluded if you install as a gem package as opposed to juts downloading the repo as basis for a site.
# Credits
- Jekyll
- The Jekyll
- Bootstrap>
- The Bootstrap
- Font Awesome
- Icons
- alembic
- Ripped a bunch template from this theme.
- forty-jekyll-theme
- Ripped a bunch template from this theme.
- octopress/paginate
- For pagination.
- ...
- Many more.
# License
The theme is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).