Skip to content

Latest commit

 

History

History
51 lines (39 loc) · 2.44 KB

index.md

File metadata and controls

51 lines (39 loc) · 2.44 KB
Raw
layout
home

Bootstrap Sass Jekyll Template for Github pages

Jekyll Bootstrap template for :octocat: Github pages (Official Sass version). No plugins needed! It also utilizes many best practices from minima theme, checkout the demo.

Note: 📖 There are a few known configuration 🐛 issues due to Jekyll sass-converter and bootstrap sass requirements. The results work fine 🚀, at least for most Bootstrap features, but it's worth 🏫 understanding Configuration & Usage in the TWBS README.

Setup

  1. Download or clone a copy of [this repository]({{ site.github.repository_url }}) into a local folder
  2. Open your local copy of the project folder
  3. Setup Bundler & Jekyll
  4. Use bundler to configure your system for the project
  5. Open your favorite text editor
  6. Run the Jekyll server
  7. Browse to http://localhost:4000

Example

git clone {{ site.github.clone_url }}
cd {{ site.github.project_title }}
gem install jekyll bundler
bundle install
atom .
bundle exec jekyll serve

How to Customize

  • Gemfile is used by bundler package manger to setup local environment.
  • _config.yml is used by to setup jekyll and plugins (or override default) site. variables, and define defaults. The syntax is standard YAML.
  • _data folder can be used for menus, social plugins, and other "data" elements.
  • To customize the style, look in assets. style.scss has info about how Jekyll uses sass. Changes should be done in assets/_sass/theme.scss or theme/_custom.scss and theme/_theme_variables.scss
  • Jekyll is made up of two defaults content types. pages are for static content. posts are for periodic content, like a blog. collections can be defined to add new content types, and can make use of _data. All can take advantage of tags & categories.
  • Customize static pages such as index.md, about.md then add/delete files in _posts

Bugs and Issues

Find a bug or have a suggestion? [Open a new issue]({{ site.github.issues_url }}) on GitHub.